Export (0) Print
Expand All

GetForm function

The GetForm function retrieves information about a specified form.

Syntax


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

Parameters

hPrinter [in]

A handle to the printer. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.

pFormName [in]

A pointer to a null-terminated string that specifies the name of the form. To get the names of the forms supported by the printer, call the EnumForms function.

Level [in]

The version of the structure to which pForm points. This value must be 1 or 2.

pForm [out]

A pointer to an array of bytes that receives the initialized FORM_INFO_1 or FORM_INFO_2 structure.

cbBuf [in]

The size, in bytes, of the pForm array.

pcbNeeded [out]

A pointer to a value that specifies the number of bytes copied if the function succeeds or the number of bytes required if cbBuf is too small.

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 will always be STRING_LANGPAIR.

Requirements

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

GetFormW (Unicode) and GetFormA (ANSI)

See also

Printing
Print Spooler API Functions
AddForm
DeleteForm
OpenPrinter
SetForm

 

 

Community Additions

ADD
Show:
© 2014 Microsoft