Export (0) Print
Expand All
6 out of 18 rated this helpful - Rate this topic

AddForm function

The AddForm function adds a form to the list of available forms that can be selected for the specified printer.

Syntax


BOOL AddForm(
  _In_  HANDLE hPrinter,
  _In_  DWORD Level,
  _In_  LPBYTE pForm
);

Parameters

hPrinter [in]

A handle to the printer that supports printing with the specified form. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.

Level [in]

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

pForm [in]

A pointer to a FORM_INFO_1 or FORM_INFO_2 structure.

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.

An application can determine which forms are available for a printer by calling the EnumForms function.

If pForm points to a FORM_INFO_2, then AddForm will fail if either a form with the specified name already exists or the structure's pKeyword value already exists.

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

Spoolss.dll

See also

Printing
Print Spooler API Functions
EnumForms
FORM_INFO_1
FORM_INFO_2
OpenPrinter

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.