Contents

PMGetCollate(_:_:)

Obtains a Boolean value that indicates whether the job collate option is selected.

Declaration

func PMGetCollate(_ printSettings: PMPrintSettings, _ collate: UnsafeMutablePointer<DarwinBoolean>) -> OSStatus

Parameters

  • printSettings:

    The print settings object you’re querying to determine whether the job collate option is selected.

  • collate:

    A pointer to your Boolean variable. On return, true if the job collate option is selected; otherwise, false.

Return Value

A result code. See Result Codes.

Discussion

The Collated checkbox is displayed in the Copies & Pages pane of the Print dialog. This option determines how printed material is organized. For example, if you have a document that is three pages long and you are printing multiple copies with the Collated option selected, the job prints pages 1, 2, and 3 in that order and then repeats. However, if the Collated option is not selected and you’re printing multiple copies of those same three pages, the job prints copies of page 1, then copies of page 2, and finally copies of page 3.

See Also

Accessing Data in Print Settings Objects