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

BOOL EnumForms(
  HANDLE hPrinter,    // handle to printer object
  DWORD Level,        // data level
  LPBYTE pForm,       // form information buffer
  DWORD cbBuf,        // size of form information buffer
  LPDWORD pcbNeeded,  // bytes received or required
  LPDWORD pcReturned  // number of forms received
);

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 Values

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

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

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.

Requirements

  Windows NT/2000/XP/Vista: Included in Windows NT 3.1 and later.
  Windows 95/98/Me: Unsupported.
  Header: Declared in Winspool.h; include Windows.h.
  Library: Use Winspool.lib.
  Unicode: Implemented as Unicode and ANSI versions.

See Also

Printing and Print Spooler Overview, Printing and Print Spooler Functions, AddPrinter, FORM_INFO_1, OpenPrinter