Pointers and arrays in Python ctypes

Question

I have a DLL containing a C function with a prototype like this:

int c_read_block(uint32 addr, uint32 *buf, uint32 num);

I want to call it from Python using ctypes. The function expects a pointer to a chunk of memory, into which it will write the results. I don't know how to construct and pass such a chunk of memory. The ctypes documentation isn't much help.

Constructing an array and passing it "byref", like this:

    cresult = (c_ulong * num)()
    err = self.c_read_block(addr, byref(cresult), num)

Gives this error message:

ArgumentError: argument 3: <type 'exceptions.TypeError'>: expected LP_c_ulong instance instead of pointer to c_ulong_Array_2

I guess that is because the Python ulong array is nothing like a c uint32 array. Should I use create_char_string. If so, how do I persuade Python to "cast" that buffer to an LP_c_ulong?

Mark Rushakoff · Accepted Answer · 2009-09-01 16:10:10Z

68

You can cast with the cast function :)

>>> import ctypes
>>> x = (ctypes.c_ulong*5)()
>>> x
<__main__.c_ulong_Array_5 object at 0x00C2DB20>
>>> ctypes.cast(x, ctypes.POINTER(ctypes.c_ulong))
<__main__.LP_c_ulong object at 0x0119FD00>
>>>

answered Sep 1, 2009 at 16:10

Mark Rushakoff

260k47 gold badges412 silver badges401 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Mark Rushakoff Over a year ago

I've used ctypes a few times and I've encountered it in the linked documentation before.

Mike Vella Over a year ago

Why i it a LP_c_ulong object and not LP_c_ulong_Array_5 object

Charles Grunwald Over a year ago

LP_c_ulong_Array_5 would be an address pointing to an address pointing to the first element in an array of uint32s, whereas the OP's function is looking to receive an address pointing to the first element of an array. LP_c_ulong_Array_5 would be for a function like: int c_read_block(uint32 addr, uint32 *buf[], uint32 num);

mara004 Mar 12 at 17:39

Better declare the .argtypes on the C function in question, then ctypes should be able to implicitly handle the array. In that case, you also don't need to think of using byref, see docs.python.org/3/library/ctypes.html#type-conversions

ephemer · Accepted Answer · 2018-08-24 12:31:00Z

4

You can cast the result, but ctypes allows you to use an array in place of a pointer, directly. The issue is the byref in your code (which would be the equivalent of a pointer to a pointer):

So instead of:

cresult = (c_ulong * num)()
err = self.c_read_block(addr, byref(cresult), num)

try:

cresult = (c_ulong * num)()
err = self.c_read_block(addr, cresult, num)

answered Aug 24, 2018 at 12:31

ephemer

1,3249 silver badges24 bronze badges

Comments

bemehow · Accepted Answer · 2016-04-25 17:41:09Z

-3

There is a typo in the solution. In order to get a pointer to an array of ulongs you need to cast to a POINTER(list of ulong)

In [33]: ptr = ctypes.cast(x, ctypes.POINTER(ctypes.c_ulong*5))
In [34]: ptr
Out[34]: <__main__.LP_c_ulong_Array_5 at 0x23e2560>

answered Apr 25, 2016 at 17:41

bemehow

1

Collectives™ on Stack Overflow

Pointers and arrays in Python ctypes

3 Answers 3

4 Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

4 Comments

Comments

Comments

Linked

Related