---
title: "CGPDFArrayGetString(_:_:_:)"
framework: coregraphics
role: symbol
role_heading: Function
path: "coregraphics/cgpdfarraygetstring(_:_:_:)"
---

# CGPDFArrayGetString(_:_:_:)

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

## Declaration

```swift
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

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

## See Also

### Getting Data from a PDF Array

- [CGPDFArrayGetArray(_:_:_:)](coregraphics/cgpdfarraygetarray(_:_:_:).md)
- [CGPDFArrayGetBoolean(_:_:_:)](coregraphics/cgpdfarraygetboolean(_:_:_:).md)
- [CGPDFArrayGetCount(_:)](coregraphics/cgpdfarraygetcount(_:).md)
- [CGPDFArrayGetDictionary(_:_:_:)](coregraphics/cgpdfarraygetdictionary(_:_:_:).md)
- [CGPDFArrayGetInteger(_:_:_:)](coregraphics/cgpdfarraygetinteger(_:_:_:).md)
- [CGPDFArrayGetName(_:_:_:)](coregraphics/cgpdfarraygetname(_:_:_:).md)
- [CGPDFArrayGetNull(_:_:)](coregraphics/cgpdfarraygetnull(_:_:).md)
- [CGPDFArrayGetNumber(_:_:_:)](coregraphics/cgpdfarraygetnumber(_:_:_:).md)
- [CGPDFArrayGetObject(_:_:_:)](coregraphics/cgpdfarraygetobject(_:_:_:).md)
- [CGPDFArrayGetStream(_:_:_:)](coregraphics/cgpdfarraygetstream(_:_:_:).md)