Prev Next

GetForm info  Overview  Group

The GetForm function initializes a FORM_INFO_1 structure with data describing the specified form for a printer.

BOOL GetForm(

    HANDLE hPrinter,

// handle of printer

    LPTSTR pFormName,

// address of form name

    DWORD Level,

// structure level

    LPBYTE pForm,

// address of structure array

    DWORD cbBuf,

// count of bytes in array

    LPDWORD pcbNeeded 

// addr. of variable with count of bytes retrieved (or required)

   );

Parameters

hPrinter
Identifies the printer.
pFormName
Points to a null-terminated string that specifies the name of the form.
Level
Specifies the version of the structure to which pForm points. This value must be 1.
pForm
Points to an array of bytes that receives the initialized FORM_INFO_1 structure.
cbBuf
Specifies the size, in bytes, of the pForm array.
pcbNeeded
Points 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 Values

If the function succeeds, the return value is nonzero.

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

Remarks

The printer handle hPrinter is obtained by calling the OpenPrinter function.

See Also

AddForm, DeleteForm, OpenPrinter, SetForm