Python ctypes：带有 LPCSTR [out] 参数的原型

Posted 2023-02-19

【中文标题】Python ctypes：带有 LPCSTR [out] 参数的原型

【英文标题】：Python ctypes: Prototype with LPCSTR [out] parameter

【发布时间】：2012-06-09 10:20:36

【问题描述】：

我目前正在进入ctypes 模块，我正在尝试使用HWND 句柄调用user32 函数GetWindowText，我已经使用FindWindow 收到了句柄。这次虽然我想更进一步，使用函数原型而不是使用ctypes.windll.user32.GetWindowText 调用函数。虽然我在将 lpString 参数声明为输出参数时遇到问题。

我的第一次尝试是这样的：

GetWindowText = cfunc("GetWindowTextA",windll.user32,c_int,
                  ("hWnd",HWND,1),
                  ("lpString",LPCSTR,2),
                  ("nMaxCount",c_int,1)
                  )

（cfunc 是我发现的一个小包装 here）

这个原型一被调用就会产生以下异常：

    chars,name = user32.GetWindowText(handle,255)
TypeError: c_char_p 'out' parameter must be passed as default value

我认为任何输出变量都必须是POINTER(...) 类型，所以我将定义更改为：

GetWindowText = cfunc("GetWindowTextA",windll.user32,c_int,
                      ("hWnd",HWND,1),
                      ("lpString",POINTER(c_char),2),
                      ("nMaxCount",c_int,1)
                      )

但这也会产生异常：

    chars,name = user32.GetWindowText(handle,255)
ctypes.ArgumentError: argument 2: <type 'exceptions.TypeError'>: wrong type

我希望有人知道如何使用ctypes 原型正确调用GetWindowText 函数。

编辑：

通过进一步的研究，我可以让它发挥作用，至少以某种方式。我修复的第一个问题是 cfunc() 的使用，它有错误的调用说明符。我定义了该函数的精确副本并将其命名为winfunc()，并将return CFUNCTYPE(result, *atypes)((name, dll), tuple(aflags)) 替换为return WINFUNCTYPE(result, *atypes)((name, dll), tuple(aflags))。

然后我进一步检查了原型设计。看起来，如果您将("someParameter",POINTER(aType),2) 传递给WINFUNCTYPE，它将在调用时创建一个aType 对象并将指向该对象的指针传递给函数。在返回的元组中，您可以访问 aType 对象。这带来了另一个问题。 cstring 是一个字符数组；所以需要告诉 ctypes 创建一个c_char array。这意味着类似：

GetWindowText = winfunc("GetWindowTextA",windll.user32,c_int,
                  ("hWnd",HWND,1),
                  ("lpString",POINTER(c_char*255),2),
                  ("nMaxCount",c_int,1)
                  )

工作得很好。但不幸的是，ctypes 现在将传递一个指向 cstring 的指针，该指针总是 255 个字符长，忽略 nMaxCount 指定的大小。

在我看来，我认为没有办法让该函数与定义为输出参数的动态大小的 cstring 一起工作。唯一的可能性似乎是简单地不使用输出参数功能并将LPCSTR 定义为输入参数。然后被调用者需要使用ctypes.create_string_buffer() 自己创建一个缓冲区并将其传递给函数（就像在 C 中一样）。

【参考方案1】：

您必须为输出参数创建一个字符串缓冲区。您可以包装该函数以使其有点透明：

# python3
from ctypes import *

_GetWindowText = WinDLL('user32').GetWindowTextW
_GetWindowText.argtypes = [c_void_p,c_wchar_p,c_int]
_GetWindowText.restype = c_int

def GetWindowText(h):
    b = create_unicode_buffer(255)
    _GetWindowText(h,b,255)
    return b.value

FindWindow = WinDLL('user32').FindWindowW
FindWindow.argtypes = [c_wchar_p,c_wchar_p]
FindWindow.restype = c_void_p

h = FindWindow(None,'Untitled - Notepad')
print(GetWindowText(h))

或者在这种情况下你可以使用pywin32:

import win32gui
h = win32gui.FindWindow(None,'Untitled - Notepad')
print(win32gui.GetWindowText(h))

【讨论】：

是的，我已经看到了 pywin32，但我不想使用，因为我需要 ctypes 与其他地方的 win32 结合使用，并且我想要持久代码（我什至可能需要交换句柄等）。同时，我遇到了原型模式的另一个问题（一个人只能访问输出参数而不是正常的返回值；不是以通用方式）并且我正在认真考虑在您接近时采用包装器解决方案或只是完全地去（也适用于它的函数）会工作）没有“输出参数”功能，这对我来说似乎未经测试。

我不确定您所说的“持久代码”是什么意思，但是如果您需要交换句柄，pywin32 PyHANDLE 对象可以从原始窗口句柄附加/分离。请参阅docs.activestate.com/activepython/2.4/pywin32/PyHANDLE.html 文档。另请注意 Python c_char_p 类型仅用于传递输入字符串。例如，仅使用create_string_buffer(255) 来制作可用于输出的缓冲区。

【参考方案2】：

是的。您必须为每次调用创建缓冲区。如果让函数定义来做，以后如何访问缓冲区？

您似乎还必须告诉它期望指针c_char 和POINTER(c_char)，而不仅仅是c_char_p 或LPSTR。不过不知道为什么会这样。

无论如何，这应该工作：

from ctypes import *
from ctypes.wintypes import *

# defs

FindWindowF = WINFUNCTYPE(HWND, LPSTR, LPSTR)
FindWindow = FindWindowF(windll.user32.FindWindowA)

GetWindowTextF = WINFUNCTYPE(c_int, HWND, POINTER(c_char), c_int)
GetWindowText = GetWindowTextF(windll.user32.GetWindowTextA)

# code

text = create_string_buffer(255)

hwnd = FindWindow(None, 'Untitled - Notepad')
GetWindowText(hwnd, text, sizeof(text))

print text.value

【讨论】：

这确实像我在编辑中写的那样工作，我认为这是目前唯一的解决方案。这个问题试图面对的问题是使用具有可变大小的 cstrings 的“输出参数”功能。关于GetWindowRect()函数有一个输出Rect*参数到堆上的一个Rect结构，可以将原型定义为prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))然后指定paramflags = (1, "hwnd"), (2, "lprect")。最后得到函数GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)。现在可以调用rect = GetWindowRect(handle)

指针问题涉及以下方面：据我所知，c_char_p 实际上是 _ctyped.pyd 中定义的本机类型。这意味着 c_char_p != POINTER(c_char)。在我看来，如果您想使用输出参数功能，paramlist 争论总是迫使您使用 POINTER(x) 类型。这样，它会在调用时创建 x 的对象并将 POINTER(x) 传递给函数。你终于得到了 x 对象。如果您虽然没有使用该功能，您当然可以使用 c_char_p 或在这种情况下使用 LPCSTR。