Function

PMPrintSettingsSetValue

Stores the value of a setting in a print settings object.

Declaration

OSStatus PMPrintSettingsSetValue(PMPrintSettings printSettings, CFStringRef key, CFTypeRef value, Boolean locked);

Parameters

printSettings

The print settings object you want to update.

key

A string constant that specifies the key for the desired setting. Some keys are currently defined in PMTicket.h; other keys are user-defined.

value

A Core Foundation object that corresponds to the specified key. If you pass NULL, any existing setting for the specified key is removed.

locked

If true, the item being set should be locked; otherwise, false. Currently, you should always pass false.

Return Value

A result code. See Result Codes.

Discussion

This function makes it possible to add, change, or remove print settings directly. Print settings are stored as key-value pairs. The keys are Core Foundation strings and the corresponding values are Core Foundation objects.

You can use this function to store user-defined data in a print settings object. You should make sure that the custom keys you define for your private data do not conflict with any other keys in the object. Each data item you store needs to be a Core Foundation object. You can use the function PMPrintSettingsGetValue to retrieve your private data.

If you call this function after initiating a print job (for example, by calling PMSessionBeginCGDocument), the change is ignored for the current job.

See Also

Accessing Data in Print Settings Objects

PMGetPrintSettingsExtendedData

Obtains extended print settings data previously stored by your application.

PMSetPrintSettingsExtendedData

Stores your application-specific data in a print settings object.

PMGetFirstPage

Obtains the number of the first page to be printed.

PMSetFirstPage

Sets the default page number of the first page to be printed.

PMGetLastPage

Obtains the number of the last page to be printed.

PMSetLastPage

Sets the page number of the last page to be printed.

PMGetPageRange

Obtains the valid range of pages that can be printed.

PMSetPageRange

Sets the valid range of pages that can be printed.

PMPrintSettingsGetJobName

Obtains the name of a print job.

PMPrintSettingsSetJobName

Specifies the name of a print job.

PMGetCopies

Obtains the number of copies that the user requests to be printed.

PMSetCopies

Sets the initial value for the number of copies to be printed.

PMGetCollate

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

PMSetCollate

Specifies whether the job collate option is selected.

PMGetDuplex

Obtains the selected duplex mode.

PMSetDuplex

Sets the duplex mode.

PMPrintSettingsGetValue

Obtains the value of a setting in a print settings object.

PMPrintSettingsCopyAsDictionary

Creates a dictionary that contains the settings in a print settings object.

PMPrintSettingsCopyKeys

Obtains the keys for items in a print settings object.

PMGetJobNameCFString

Obtains the name of the print job.

PMSetJobNameCFString

Specifies the name of a print job.