CDC::StartDoc

Syntax

int StartDoc( const char FAR* pDocName );

Parameters

pDocName

Pointer to a null-terminated string that specifies the name of the document. The document name is displayed in the Print Manager window. The maximum length of this string is 31 characters plus the terminating null character.

Remarks

Informs the device driver that a new print job is starting and that all subsequent NEWFRAME escape calls should be spooled under the same job until an ENDDOC escape call occurs. This ensures that documents longer than one page will not be interspersed with other jobs.

Return Value

The value -1 if there is an error such as insufficient memory or an invalid port specification occurs. Otherwise, a positive value.

See Also

CDC::Escape, CDC::EndDoc