GdiDeleteSpoolFileHandle function

The GdiDeleteSpoolFileHandle function releases a spool file handle.

Syntax


BOOL GdiDeleteSpoolFileHandle(
   HANDLE SpoolFileHandle
);

Parameters

SpoolFileHandle

Caller-supplied spool file handle, obtained by a previous call to GdiGetSpoolFileHandle.

Return value

If the operation succeeds, the function returns TRUE. Otherwise the function returns FALSE.

Remarks

The GdiDeleteSpoolFileHandle function is exported by gdi32.dll for use within a print processor's PrintDocumentOnPrintProcessor function.

Print processors should call GdiDeleteSpoolFileHandle after calling GdiEndDocEMF, when processing a print job's EMF data stream has been completed. The function calls ClosePrinter (described in the Microsoft Window SDK documentation) to close the printer connection.

For additional information, see Using GDI Functions in Print Processors.

Requirements

Target platform

Universal

Header

Winppi.h (include Winppi.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

GdiGetSpoolFileHandle

 

 

Send comments about this topic to Microsoft

Show: