CGPDFArray

Overview

PDF arrays may be heterogeneous—that is, they may contain any other PDF objects, including PDF strings, PDF dictionaries, and other PDF arrays.

Many CGPDFArray functions to retrieve values from a PDF array take the form:

bool CGPDFArrayGet<DataType> (
 CGPDFArrayRef array,
 size_t index,
 <DataType>Ref *value
);

These functions test the data type of the object at the specified index. If the object is not of the expected type, the function returns false. If the object is of the expected type, the function returns true, and the object is passed back in the value parameter.

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

Topics

Getting Data from a PDF Array

• CGPDFArrayGetArray(_:_:_:)
• CGPDFArrayGetBoolean(_:_:_:)
• CGPDFArrayGetCount(_:)
• CGPDFArrayGetDictionary(_:_:_:)
• CGPDFArrayGetInteger(_:_:_:)
• CGPDFArrayGetName(_:_:_:)
• CGPDFArrayGetNull(_:_:)
• CGPDFArrayGetNumber(_:_:_:)
• CGPDFArrayGetObject(_:_:_:)
• CGPDFArrayGetStream(_:_:_:)
• CGPDFArrayGetString(_:_:_:)

Data Types

• CGPDFArrayRef

See Also

Related Documentation

• Quartz 2D Programming Guide