CGPDFDictionary

Overview

Dictionary objects are the main building blocks of a PDF document. A key-value pair within a dictionary is called an entry. In a PDF dictionary, the key must be an array of characters. Within a given dictionary, the keys are unique—that is, no two keys in a single dictionary are equal (as determined by strcmp). The value associated with a key can be any kind of PDF object, including another dictionary. Dictionary objects are the main building blocks of a PDF document.

Many functions that retrieve values from a PDF dictionary take the form:

bool CGPDFDictionaryGet<DataType> (
 CGPDFDictionaryRef dictionary,
 const char *key,
 <DataType>Ref *value
);

These functions test whether there is an object associated with the specified key. If there is an object associated with the specified key, they test its data type. If there is no associated object, or if there is but it is not of the expected type, the function returns false. If there is an object associated with the specified key and it is of the expected type, the function returns true and the object is passed back in the value parameter.

This object is not derived from CFType and therefore there are no functions for retaining and releasing it. CGPDFDictionary objects exist only as constituent parts of a CGPDFDocument object, and they are managed by their container.

Topics

Applying a Function to All Entries

• CGPDFDictionaryApplyFunction(_:_:_:)

Getting Data from a Dictionary

• CGPDFDictionaryGetArray(_:_:_:)
• CGPDFDictionaryGetBoolean(_:_:_:)
• CGPDFDictionaryGetCount(_:)
• CGPDFDictionaryGetDictionary(_:_:_:)
• CGPDFDictionaryGetInteger(_:_:_:)
• CGPDFDictionaryGetName(_:_:_:)
• CGPDFDictionaryGetNumber(_:_:_:)
• CGPDFDictionaryGetObject(_:_:_:)
• CGPDFDictionaryGetStream(_:_:_:)
• CGPDFDictionaryGetString(_:_:_:)

Callbacks

• CGPDFDictionaryApplierFunction

Data Types

• CGPDFDictionaryRef

See Also

Related Documentation

• Quartz 2D Programming Guide