EnumForms function

Article
01/07/2021

The EnumForms function enumerates the forms supported by the specified printer.

Syntax

BOOL EnumForms(
  _In_  HANDLE  hPrinter,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

Parameters

hPrinter [in]: Handle to the printer for which the forms should be enumerated. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.
Level [in]: Specifies the version of the structure to which pForm points. This value must be 1 or 2.
pForm [out]: Pointer to one or more FORM_INFO_1 structures or to one or more FORM_INFO_2 structures. All the structures will have the same level.
cbBuf [in]: Specifies the size, in bytes, of the buffer to which pForm points.
pcbNeeded [out]: Pointer to a variable that receives the number of bytes copied to the array to which pForm points (if the operation succeeds) or the number of bytes required (if it fails because cbBuf is too small).
pcReturned [out]: Pointer to a variable that receives the number of structures copied into the array to which pForm points.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero.

Remarks

Note

This is a blocking or synchronous function and might not return immediately. How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

If the caller is remote, and the Level is 2, the StringType value of the returned FORM_INFO_2 structures will always be STRING_LANGPAIR.

In Windows Vista, the form data returned by EnumForms is retrieved from a local cache when hPrinter refers to a remote print server or a printer hosted by a print server and there is at least one open connection to a printer on the remote print server. In all other configurations, the form data is queried from the remote print server.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Winspool.h (include Windows.h)
Library	Winspool.lib
DLL	Winspool.drv
Unicode and ANSI names	EnumFormsW (Unicode) and EnumFormsA (ANSI)