StartDocPrinter info  Overview  Group

The StartDocPrinter function informs the print spooler that a document is to be spooled for printing.

DWORD StartDocPrinter(

HANDLE hPrinter,	// handle of printer object
DWORD Level,	// structure level
LPBYTE pDocInfo	// address of structure
);

Parameters

hPrinter

Identifies the printer.

Level

Specifies the version of the structure to which pDocInfo points. This value must be 1 for Windows NT. For Windows 95, you can also select a value of 2. (See DOC_INFO_2 following.)

pDocInfo

Points to a DOC_INFO_1 structure or a DOC_INFO_2 structure. If dwlevel is 1, the function stores the data in a DOC_INFO_1 structure. If dwlevel is 2, the function stores the data in a DOC_INFO_2 structure.

Windows 95: The DOC_INFO_2 structure has the following form:

typedef struct _DOC_INFO_2 { // dci2 

    LPTSTR pDocName; 

    LPTSTR pOutputFile; 

    LPTSTR pDatatype; 

    DWORD dwMode; 

    DWORD JobId; 

} DOC_INFO_2;

 

Return Values

If the function succeeds, the return value identifies the print job.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The printer handle identified by the hPrinter parameter is obtained by calling the OpenPrinter function.

The return value will never be greater than 2^31 - 1.

See Also

DOC_INFO_1, OpenPrinter