GetForm 函数

  • 项目

GetForm 函数检索有关指定窗体的信息。

语法

BOOL GetForm(
  _In_  HANDLE  hPrinter,
  _In_  LPTSTR  pFormName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

参数

hPrinter [in]

打印机的句柄。 使用 OpenPrinter 或 AddPrinter 函数检索打印机句柄。

pFormName [in]

指向以 null 结尾的字符串的指针，该字符串指定窗体的名称。 若要获取打印机支持的窗体的名称，请调用 EnumForms 函数。

级别 [in]

pForm 指向的结构的版本。 此值必须为 1 或 2。

pForm [out]

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

cbBuf [in]

pForm 数组的大小（以字节为单位）。

线路板 [out]

指向值的指针，该值指定在函数成功时复制的字节数;如果 cbBuf 太小，则指定所需的字节数。

返回值

如果函数成功，则返回值为非零值。

如果函数失败，则返回值为零。

注解

注意

这是一个阻塞或同步函数，可能不会立即返回。 此函数的返回速度取决于运行时因素，例如网络状态、打印服务器配置以及编写应用程序时难以预测的打印机驱动程序实现因素。 从管理与用户界面交互的线程调用此函数可能会使应用程序看起来无响应。

如果调用方是远程调用方，而级别为 2，则返回FORM_INFO_2的 StringType 值将始终STRING_LANGPAIR。

要求

要求 值
最低受支持的客户端
 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器
 Windows 2000 Server [仅限桌面应用]
标头
Winspool.h (包括 Windows.h)
库
Winspool.lib
DLL
Winspool.drv
Unicode 和 ANSI 名称
 GetFormW (Unicode) 和 GetFormA (ANSI)

另请参阅

打印

打印后台处理程序 API 函数

AddForm

DeleteForm

OpenPrinter

SetForm