CGPDFScanner Reference

Overview

The CGPDFScannerRef opaque type is used to parse a PDF content stream. You can set up the PDF scanner object to invoke callbacks when it encounters specific PDF operators in the stream.

This opaque type is not derived from CFType. Use CGPDFScannerRetain and CGPDFScannerRelease to manage the retain count of CGPDFScannerRef instances; do not use CFRetain and CFRelease.

Functions by Task

Creating a PDF Scanner Object

• CGPDFScannerCreate

Retaining and Releasing PDF Scanner Objects

• CGPDFScannerRetain
• CGPDFScannerRelease

Parsing Content

• CGPDFScannerScan
• CGPDFScannerGetContentStream

Getting PDF Objects from the Scanner Stack

• CGPDFScannerPopObject
• CGPDFScannerPopBoolean
• CGPDFScannerPopInteger
• CGPDFScannerPopNumber
• CGPDFScannerPopName
• CGPDFScannerPopString
• CGPDFScannerPopArray
• CGPDFScannerPopDictionary
• CGPDFScannerPopStream

Functions

CGPDFScannerCreate

Creates a PDF scanner.

CGPDFScannerRef CGPDFScannerCreate (
   CGPDFContentStreamRef cs,
   CGPDFOperatorTableRef table,
   void *info
);

CGPDFScannerGetContentStream

Returns the content stream associated with a PDF scanner object.

CGPDFContentStreamRef CGPDFScannerGetContentStream (
   CGPDFScannerRef scanner
);

CGPDFScannerPopArray

Retrieves an array object from the scanner stack.

bool CGPDFScannerPopArray (
   CGPDFScannerRef scanner,
   CGPDFArrayRef *value
);

CGPDFScannerPopBoolean

Retrieves a Boolean object from the scanner stack.

bool CGPDFScannerPopBoolean (
   CGPDFScannerRef scanner,
   CGPDFBoolean *value
);

CGPDFScannerPopDictionary

Retrieves a PDF dictionary object from the scanner stack.

bool CGPDFScannerPopDictionary (
   CGPDFScannerRef scanner,
   CGPDFDictionaryRef *value
);

CGPDFScannerPopInteger

Retrieves an integer object from the scanner stack.

bool CGPDFScannerPopInteger (
   CGPDFScannerRef scanner,
   CGPDFInteger *value
);

CGPDFScannerPopName

Retrieves a character string from the scanner stack.

bool CGPDFScannerPopName (
   CGPDFScannerRef scanner,
   const char **value
);

CGPDFScannerPopNumber

Retrieves a real value object from the scanner stack.

bool CGPDFScannerPopNumber (
   CGPDFScannerRef scanner,
   CGPDFReal *value
);

CGPDFScannerPopObject

Retrieves an object from the scanner stack.

bool CGPDFScannerPopObject (
   CGPDFScannerRef scanner,
   CGPDFObjectRef *value
);

CGPDFScannerPopStream

Retrieves a PDF stream object from the scanner stack.

bool CGPDFScannerPopStream (
   CGPDFScannerRef scanner,
   CGPDFStreamRef *value
);

CGPDFScannerPopString

Retrieves a string object from the scanner stack.

bool CGPDFScannerPopString (
   CGPDFScannerRef scanner,
   CGPDFStringRef *value
);

CGPDFScannerRelease

Decrements the retain count of a scanner object.

void CGPDFScannerRelease (
   CGPDFScannerRef scanner
);

CGPDFScannerRetain

Increments the retain count of a scanner object.

CGPDFScannerRef CGPDFScannerRetain (
   CGPDFScannerRef scanner
);

CGPDFScannerScan

Parses the content stream of a PDF scanner object.

bool CGPDFScannerScan (
   CGPDFScannerRef scanner
);

Data Types

CGPDFScannerRef

An opaque type used to parse a PDF content stream.

typedef struct CGPDFScanner *CGPDFScannerRef;