Share via

EngGetForm 函数 (winddi.h)

  • 项目

EngGetForm 函数获取指定窗体的FORM_INFO_1详细信息。

语法

ENGAPI BOOL EngGetForm(
  [in]           HANDLE  hPrinter,
  [in]           LPWSTR  pFormName,
  [in]           DWORD   Level,
  [in, optional] LPBYTE  pForm,
  [in]           DWORD   cbBuf,
  [out]          LPDWORD pcbNeeded
);

参数

[in] hPrinter

要为其指定窗体的打印机的句柄。

[in] pFormName

指向指定窗体名称的字符串的指针。

[in] Level

指定 pForm 指向的窗体结构的版本。 此值必须为 1，表示表单信息将在FORM_INFO_1结构中返回。

[in, optional] pForm

指向接收初始化FORM_INFO_1结构的字节数组的指针。

[in] cbBuf

指定 pForm 的大小（以字节为单位）。

[out] pcbNeeded

指向一个值的指针，该值指定在函数成功的情况下复制到 pForm 指向的缓冲区中的字节数。 如果 cbBuf 太小，该值是执行复制所需的字节数。

返回值

如果成功将窗体结构复制到 pForm 中，则 EngGetForm 返回 TRUE。 否则，它会记录错误消息并返回 FALSE。 若要获取错误信息，请调用 EngGetLastError。

注解

EngGetForm 返回 (Microsoft Windows SDK文档中所述的FORM_INFO_1结构，) 包含与 pFormName 关联的表单数据。 写入的数据及其大小分别通过 pForm 和 pcNeeded 返回给调用方。 如果 pForm 指向的数组不够大，无法容纳表单数据，则会改为在 “pcneed”中返回必需的数组大小。

若要获取所有受支持表单的列表，打印机驱动程序应调用 EngEnumForms。

要求

要求 值
最低受支持的客户端 在 Windows 2000 及更高版本的 Windows 操作系统中可用。
目标平台 通用
标头 winddi.h (包括 Winddi.h)
Library Win32k.lib
DLL Win32k.sys

另请参阅

EngEnumForms

EngGetLastError