The Spool Library: 4.6 Print Control Instance Data: Document Name Output

| Up: GEOS SDK TechDocs | Up | Prev: 4.5 Print Output Object | Next: 4.7 The Default Printer 
PCI_docNameOutput, MSG_PRINT_GET_DOC_NAME

The PCI_docNameOutput field must contain the optr of an object which can tell the Spooler the document's name. The document name is displayed on the Printer Control Panel and is how the user can figure out which job is which on the queue. If a GenDocumentGroup is set as the Print Control's PCI_docNameOutput , then that object will automatically do the right thing. If you use some other type of object, it must be prepared to supply document names on demand. This demand will come in the form of a MSG_PRINT_GET_DOC_NAME .

This message comes with a pointer back to the Print Control. The handler should respond by sending a MSG_PRINT_CONTROL_SET_DOC_NAME with a string containing the name.

MSG_PRINT_GET_DOC_NAME

void	MSG_PRINT_GET_DOC_NAME(
        optr	printControlOD);

If your PCI_docNameOutput object is not a GenDocumentGroup, then it must have a handler for this message.

Source: PrintControl object.

Destination: The object specified in PCI_docNameOutput .

Parameters: printControlOD The optr of the PrintControl object.

Return: Nothing returned explicitly, but should send a MSG_PRINT_CONTROL_SET_DOC_NAME back to the Print Control.

Interception: If receiving object is a GenDocument, unlikely. Otherwise, interception is necessary.

| Up: GEOS SDK TechDocs | Up | Prev: 4.5 Print Output Object | Next: 4.7 The Default Printer