ClosePrinter function
The ClosePrinter function closes the specified printer object.
Syntax
BOOL ClosePrinter(
_In_ HANDLE hPrinter
);
Parameters
-
hPrinter [in]
-
A handle to the printer object to be closed. This handle is returned by the OpenPrinter or AddPrinter function.
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.
When the ClosePrinter function returns, the handle hPrinter is invalid, regardless of whether the function has succeeded or failed.
Examples
For a sample program that uses this function, see How To: Print Using the GDI Print API.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 2000 Professional [desktop apps only] |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| Header |
|
| Library |
|
| DLL |
|