Skip to content

Latest commit

 

History

History
80 lines (61 loc) · 3.24 KB

nf-winppi-gdistartdocemf.md

File metadata and controls

80 lines (61 loc) · 3.24 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:winppi.GdiStartDocEMF
GdiStartDocEMF function (winppi.h)
The GdiStartDocEMF function performs initialization operations for an EMF-formatted print job.
print\gdistartdocemf.htm
print
04/20/2018
GdiStartDocEMF function
GdiStartDocEMF, GdiStartDocEMF function [Print Devices], gdifnc_11790088-e5fa-4817-a7d7-79c654814062.xml, print.gdistartdocemf, winppi/GdiStartDocEMF
winppi.h
Winppi.h
Universal
Gdi32.Lib
Gdi32.dll
Windows
GdiStartDocEMF
winppi/GdiStartDocEMF
APIRef
kbSyntax
DllExport
Gdi32.dll
Ext-MS-Win-GDI-Internal-Desktop-L1-1-0.dll
GDI32Full.dll
GdiStartDocEMF

GdiStartDocEMF function

-description

The GdiStartDocEMF function performs initialization operations for an EMF-formatted print job.

-parameters

-param SpoolFileHandle

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

-param pDocInfo

Caller-supplied pointer to a DOCINFOW structure (described in the Microsoft Window SDK documentation).

-returns

If the operation succeeds, the function returns TRUE. Otherwise the function returns FALSE, and an error code can be obtained by calling GetLastError.

-remarks

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

The function performs initializations that must take place before a print job's EMF records can be played. The function calls the spooler's StartDoc function (described in the Window SDK documentation), which in turn calls the printer driver's DrvStartDoc function.

The print processor must set the lpszOutput member of the DOCINFOW structure to the output file name contained in the PRINTPROCESSOROPENDATA structure, previously received by the OpenPrintProcessor function.

The print processor must set the lpszDocName member of the DOCINFOW structure to the document name pointer, previously received by the PrintDocumentOnPrintProcessor function.

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

-see-also

GdiEndDocEMF