---
title: "PMSetCollate(_:_:)"
framework: applicationservices
role: symbol
role_heading: Function
path: applicationservices/1463223-pmsetcollate
---

# PMSetCollate(_:_:)

Specifies whether the job collate option is selected.

## Declaration

```swift
func PMSetCollate(_ printSettings: PMPrintSettings, _ collate: Bool) -> OSStatus
```

## Parameters

- `printSettings`: The print settings object whose job collate option you want to set.
- `collate`: If true, the job collate option is selected; if false the option is not selected.

## Return Value

Return Value A result code. See Result Codes.

## Discussion

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. If you call this function after initiating a print job, the change is ignored for the current job.

## See Also

### Accessing Data in Print Settings Objects

- [PMGetFirstPage(_:_:)](applicationservices/1460271-pmgetfirstpage.md)
- [PMSetFirstPage(_:_:_:)](applicationservices/1461519-pmsetfirstpage.md)
- [PMGetLastPage(_:_:)](applicationservices/1462747-pmgetlastpage.md)
- [PMSetLastPage(_:_:_:)](applicationservices/1463595-pmsetlastpage.md)
- [PMGetPageRange(_:_:_:)](applicationservices/1459324-pmgetpagerange.md)
- [PMSetPageRange(_:_:_:)](applicationservices/1462294-pmsetpagerange.md)
- [PMPrintSettingsGetJobName(_:_:)](applicationservices/1459233-pmprintsettingsgetjobname.md)
- [PMPrintSettingsSetJobName(_:_:)](applicationservices/1460149-pmprintsettingssetjobname.md)
- [PMGetCopies(_:_:)](applicationservices/1464480-pmgetcopies.md)
- [PMSetCopies(_:_:_:)](applicationservices/1463804-pmsetcopies.md)
- [PMGetCollate(_:_:)](applicationservices/1464492-pmgetcollate.md)
- [PMGetDuplex(_:_:)](applicationservices/1458921-pmgetduplex.md)
- [PMSetDuplex(_:_:)](applicationservices/1462000-pmsetduplex.md)
- [PMPrintSettingsGetValue(_:_:_:)](applicationservices/1460602-pmprintsettingsgetvalue.md)
- [PMPrintSettingsSetValue(_:_:_:_:)](applicationservices/1461697-pmprintsettingssetvalue.md)
- [PMPrintSettingsCopyAsDictionary(_:_:)](applicationservices/1459088-pmprintsettingscopyasdictionary.md)
- [PMPrintSettingsCopyKeys(_:_:)](applicationservices/1462730-pmprintsettingscopykeys.md)