Contents

PMPrintSettingsSetValue(_:_:_:_:)

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

Declaration

func PMPrintSettingsSetValue(_ printSettings: PMPrintSettings, _ key: CFString, _ value: CFTypeRef?, _ locked: Bool) -> OSStatus

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