CloseSpoolFileHandle function

The CloseSpoolFileHandle function closes a handle to a spool file associated with the print job currently submitted by the application.

Syntax


BOOL CloseSpoolFileHandle(
  _In_ HANDLE hPrinter,
  _In_ HANDLE hSpoolFile
);

Parameters

hPrinter [in]

A handle to the printer to which the job was submitted. This should be the same handle that was used to obtain hSpoolFile with GetSpoolFileHandle.

hSpoolFile [in]

A handle to the spool file being closed. If CommitSpoolData has not been called since GetSpoolFileHandle was called, then this should be the same handle that was returned by GetSpoolFileHandle. Otherwise, it should be the handle that was returned by the most recent call to CommitSpoolData.

Return value

TRUE, if it succeeds, FALSE otherwise.

Remarks

Your application must not call ClosePrinter on hPrinter until after it has accessed the spool file for the last time. Then it should call CloseSpoolFileHandle followed by ClosePrinter. Attempts to access the spool file handle after the original hPrinter has been closed will fail even if the file handle itself has not been closed. CloseSpoolFileHandle will fail if ClosePrinter is called first.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Winspool.h (include Windows.h)

Library

Winspool.lib

DLL

WinSpool.drv

See also

Printing
Print Spooler API Functions
ClosePrinter
GetSpoolFileHandle

 

 

Show: