Contents

CGPDFArrayGetString(_:_:_:)

Returns whether an object at a given index in a PDF array is a PDF string and, if so, retrieves that string.

Declaration

func CGPDFArrayGetString(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFStringRef?>?) -> Bool

Parameters

  • array:

    A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.

  • index:

    The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.

  • value:

    On input, a pointer to a PDF string. If the value at the specified index is a PDF string, then on return that string, otherwise the value is undefined.

Return Value

Returns true if there is a PDF stream at the specified index, otherwise false.

See Also

Getting Data from a PDF Array