---

CGPDFStream Reference

Overview

The CGPDFStreamRef opaque type represents a PDF stream. A PDF stream consists of a dictionary that describes a sequence of bytes. Streams typically represent objects with potentially large amounts of data, such as images and page descriptions.

Functions

CGPDFStreamCopyData

Returns the data associated with a PDF stream.

CFDataRef CGPDFStreamCopyData (
   CGPDFStreamRef stream,
   CGPDFDataFormat *format
);

Parameters

stream

A PDF stream.

format

On return, contains a constant that specifies the format of the data returned—CGPDFDataFormatRaw, CGPDFDataFormatJPEGEncoded, or CGPDFDataFormatJPEG2000.

Return Value

A CFData object that contains a copy of the stream data. You are responsible for releasing this object.

Availability

• Available in Mac OS X version 10.3 and later.

Declared In

CGPDFStream.h

CGPDFStreamGetDictionary

Returns the dictionary associated with a PDF stream.

CGPDFDictionaryRef CGPDFStreamGetDictionary (
   CGPDFStreamRef stream
);

Parameters

stream

A PDF stream.

Return Value

The PDF dictionary for the specified stream.

Availability

• Available in Mac OS X version 10.3 and later.

Declared In

CGPDFStream.h

Data Types

CGPDFStream

An opaque type that represents a PDF stream.

typedef struct CGPDFStream *CGPDFStreamRef;

Availability

• Available in Mac OS X v10.3 and later.

Declared In

CGPDFStream.h

Constants

CGPDFDataFormat

The encoding format of PDF data.

enum CGPDFDataFormat {
   CGPDFDataFormatRaw,
   CGPDFDataFormatJPEGEncoded,
   CGPDFDataFormatJPEG2000
};
typedef enum CGPDFDataFormat CGPDFDataFormat;

Constants

CGPDFDataFormatRaw

The data stream is not encoded.

Available in Mac OS X v10.3 and later.

Declared in CGPDFStream.h

CGPDFDataFormatJPEGEncoded

The data stream is encoded in JPEG format.

Available in Mac OS X v10.3 and later.

Declared in CGPDFStream.h

CGPDFDataFormatJPEG2000

The data stream is encoded in JPEG-2000 format.

Available in Mac OS X v10.4 and later.

Declared in CGPDFStream.h

Availability

• Available in Mac OS X version 10.3 and later.

Declared In

CGPDFStream.h

---