EngGetForm function (winddi.h)

Article
02/22/2024

The EngGetForm function gets the FORM_INFO_1 details for the specified form.

Syntax

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

Parameters

[in] hPrinter

Handle to the printer for which the form is being specified.

[in] pFormName

Pointer to a string that specifies the name of the form.

[in] Level

Specifies the version of the form structure to which pForm points. This value must be 1, which indicates that the form information will be returned in a FORM_INFO_1 structure.

[in, optional] pForm

Pointer to an array of bytes that receives the initialized FORM_INFO_1 structure.

[in] cbBuf

Specifies the size, in bytes, of pForm.

[out] pcbNeeded

Pointer to a value that specifies the number of bytes copied into the buffer pointed to by pForm if the function succeeds. The value is the number of bytes required to perform the copy if cbBuf is too small.

Return value

EngGetForm returns TRUE if the form structure is successfully copied into pForm. Otherwise, it logs an error message and returns FALSE. To get the error information, call EngGetLastError.

Remarks

EngGetForm returns a FORM_INFO_1 structure (described in the Microsoft Windows SDK documentation) containing the form data associated with pFormName. The written data and its size are returned to the caller via pForm and pcbNeeded, respectively. If the array pointed to by pForm is not large enough to hold the form data, the requisite array size is instead returned in pcbNeeded.

To get a list of all supported forms, the printer driver should call EngEnumForms.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform	Universal
Header	winddi.h (include Winddi.h)
Library	Win32k.lib
DLL	Win32k.sys