DeleteForm function
The DeleteForm function removes a form name from the list of supported forms.
Syntax
BOOL DeleteForm(
_In_ HANDLE hPrinter,
_In_ LPTSTR pFormName
);
Parameters
-
hPrinter [in]
-
Indicates the open printer handle that this function is to be performed upon. Use the OpenPrinter or AddPrinter function to retrieve a printer handle.
-
pFormName [in]
-
Pointer to the form name to be removed.
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.
DeleteForm can only delete form names that were added by using the AddForm function.
Requirements
Requirement | Value |
---|---|
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
Minimum supported server |
Windows 2000 Server [desktop apps only] |
Header |
|
Library |
|
DLL |
|
Unicode and ANSI names |
DeleteFormW (Unicode) and DeleteFormA (ANSI) |