Ссылка CGPDFDictionary
Наследование
Не применимый
Соответствует
Не применимый
Оператор импорта
Swift
import CoreGraphics
Objective C
@import CoreGraphics;
CGPDFDictionaryRef
непрозрачный тип инкапсулирует словарь PDF, пары ключ/значение которого могут указать любой вид объекта PDF, включая другой словарь. Объекты словаря являются основными стандартными блоками документа в формате PDF. Пару ключ/значение в словаре вызывают записью. В словаре PDF ключ должен быть массивом символов. В данном словаре ключи уникальны — т.е. никакие два ключа в единственном словаре не равны (как определено strcmp
). Значение, связанное с ключом, может быть любым видом объекта PDF, включая другой словарь. Объекты словаря являются основными стандартными блоками документа в формате PDF.
Много функций, получающих значения из словаря PDF, принимают форму:
bool CGPDFDictionaryGet<DataType> (
CGPDFDictionaryRef dictionary,
const char *key,
<DataType>Ref *value
);
Эти функции тестируют, существует ли объект, связанный с указанным ключом. Если существует объект, связанный с указанным ключом, они тестируют его тип данных. Если нет никакого связанного объекта, или если существует всего лишь, это не имеет ожидаемого типа, функциональных возвратов false
. Если существует объект, связанный с указанным ключом, и это имеет ожидаемый тип, функциональные возвраты true
и объект пасуется назад в value
параметр.
Этот непрозрачный тип не получен из CFType и поэтому нет никаких функций для сохранения и выпуска его. Объекты CGPDFDictionary существуют только как составные части объекта CGPDFDocument, и ими управляет их контейнер.
-
Применяет функцию к каждой записи в словаре.
Объявление
Swift
func CGPDFDictionaryApplyFunction(_
dictionary
: CGPDFDictionaryRef, _function
: CGPDFDictionaryApplierFunction, _info
: UnsafeMutablePointer<Void>)Objective C
void CGPDFDictionaryApplyFunction ( CGPDFDictionaryRef dict, CGPDFDictionaryApplierFunction function, void *info );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
function
Функция для применения к каждой записи в словаре.
info
Указатель на контекстную информацию для передачи функции.
Обсуждение
Эта функция перечисляет все записи в словаре, вызывая функцию один раз для каждого. Текущий ключ, его присваиваемое значение и контекстная информация передаются функции (см. также CGPDFDictionaryApplierFunction).
Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли массив PDF, связанный с указанным ключом в словаре PDF и, если так, получают тот массив.
Объявление
Swift
func CGPDFDictionaryGetArray(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFArrayRef>) -> BoolObjective C
bool CGPDFDictionaryGetArray ( CGPDFDictionaryRef dict, const char *key, CGPDFArrayRef *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, неинициализированном указателе на массив PDF. Если значение, связанное с указанным ключом, является массивом PDF, то по возврату содержит тот массив; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует массив PDF, связанный с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли булево значение PDF, связанное с указанным ключом в словаре PDF и, если так, получают булево значение.
Объявление
Swift
func CGPDFDictionaryGetBoolean(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFBoolean>) -> BoolObjective C
bool CGPDFDictionaryGetBoolean ( CGPDFDictionaryRef dict, const char *key, CGPDFBoolean *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, указателе на булево значение PDF. Если значение, связанное с указанным ключом, является булевым значением PDF, то по возврату содержит то значение; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует булево значение PDF, связанное с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвращает число записей в словаре PDF.
Объявление
Swift
func CGPDFDictionaryGetCount(_
dictionary
: CGPDFDictionaryRef) -> IntObjective C
size_t CGPDFDictionaryGetCount ( CGPDFDictionaryRef dict );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
Возвращаемое значение
Возвращает число записей в словаре.
Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли другой словарь PDF, связанный с указанным ключом в словаре PDF и, если так, получают тот словарь.
Объявление
Swift
func CGPDFDictionaryGetDictionary(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFDictionaryRef>) -> BoolObjective C
bool CGPDFDictionaryGetDictionary ( CGPDFDictionaryRef dict, const char *key, CGPDFDictionaryRef *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, указателе на словарь PDF. Если значение, связанное с указанным ключом, является словарем PDF, то по возврату содержит тот словарь; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует словарь PDF, связанный с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли целое число PDF, связанное с указанным ключом в словаре PDF и, если так, получают то целое число.
Объявление
Swift
func CGPDFDictionaryGetInteger(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFInteger>) -> BoolObjective C
bool CGPDFDictionaryGetInteger ( CGPDFDictionaryRef dict, const char *key, CGPDFInteger *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, указателе на целое число PDF. Если значение, связанное с указанным ключом, является целым числом PDF, то по возврату содержит то значение; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует целое число PDF, связанное с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, является ли объект с указанным ключом в словаре PDF ссылкой имени PDF (представленный как постоянная струна до) и, если так, получают то имя.
Объявление
Swift
func CGPDFDictionaryGetName(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<UnsafePointer<Int8>>) -> BoolObjective C
bool CGPDFDictionaryGetName ( CGPDFDictionaryRef dict, const char *key, const char **value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе указатель на PDF называет ссылку, представленную как постоянная струна до. Если значение, связанное с указанным ключом, является ссылкой на имя PDF, то по возврату, переменная указывает на имя; иначе, значение не определено.
Возвращаемое значение
Возвраты
true
если существует символьный массив, связанный с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли число PDF, связанное с указанным ключом в словаре PDF и, если так, получают то число.
Объявление
Swift
func CGPDFDictionaryGetNumber(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFReal>) -> BoolObjective C
bool CGPDFDictionaryGetNumber ( CGPDFDictionaryRef dict, const char *key, CGPDFReal *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, указателе на число PDF. Если значение, связанное с указанным ключом, является числом PDF (реальный или целочисленный), то по возврату содержит то значение; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует число PDF, связанное с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли объект PDF, связанный с указанным ключом в словаре PDF и, если так, получают тот объект.
Объявление
Swift
func CGPDFDictionaryGetObject(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFObjectRef>) -> BoolObjective C
bool CGPDFDictionaryGetObject ( CGPDFDictionaryRef dict, const char *key, CGPDFObjectRef *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, указателе на объект PDF. Если значение, связанное с указанным ключом, является объектом PDF, то по возврату содержит тот объект; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует объект PDF, связанный с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли поток PDF, связанный с указанным ключом в словаре PDF и, если так, получают тот поток.
Объявление
Swift
func CGPDFDictionaryGetStream(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFStreamRef>) -> BoolObjective C
bool CGPDFDictionaryGetStream ( CGPDFDictionaryRef dict, const char *key, CGPDFStreamRef *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения, которое будет получено.
value
На вводе, указателе на поток PDF. Если значение, связанное с указанным ключом, является потоком PDF, то по возврату содержит тот поток; иначе, значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует поток PDF, связанный с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Возвраты, существует ли строка PDF, связанная с указанным ключом в словаре PDF и, если так, получают ту строку.
Объявление
Swift
func CGPDFDictionaryGetString(_
dictionary
: CGPDFDictionaryRef, _key
: UnsafePointer<Int8>, _value
: UnsafeMutablePointer<CGPDFStringRef>) -> BoolObjective C
bool CGPDFDictionaryGetString ( CGPDFDictionaryRef dict, const char *key, CGPDFStringRef *value );
Параметры
dictionary
Словарь PDF. Если этот параметр не является допустимым словарем PDF, поведение не определено.
key
Ключ для значения для получения.
value
На вводе, указателе на строку PDF. Если значение, связанное с указанным ключом, является строкой PDF, то по возврату содержит ту строку; иначе значение является неуказанным.
Возвращаемое значение
Возвраты
true
если существует строка PDF, связанная с указанным ключом; иначе,false
.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Выполняет пользовательскую обработку на паре ключ/значение из словаря PDF, с помощью дополнительной контекстной информации.
Объявление
Swift
typealias CGPDFDictionaryApplierFunction = CFunctionPointer<((UnsafePointer<Int8>, CGPDFObjectRef, UnsafeMutablePointer<Void>) -> Void)>
Objective C
typedef void (*CGPDFDictionaryApplierFunction) ( const char *key, CGPDFObjectRef value, void *info, );
Параметры
key
Текущий ключ в словаре.
object
Значение в словаре связалось с ключом.
info
Контекстная информация, что Ваше предоставленное в
info
параметр вCGPDFDictionaryApplyFunction
.Обсуждение
CGPDFDictionaryApplierFunction
определяет обратный вызов дляCGPDFDictionaryApplyFunction
, это перечисляет все записи в словаре, вызывая Вашу пользовательскую applier функцию один раз для каждой записи. Текущий ключ, его присваиваемое значение и контекстная информация передаются Вашей функции applier использованиеkey
,value
, иinfo
параметры соответственно.Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.
-
Непрозрачный тип, инкапсулирующий словарь PDF.
Объявление
Swift
typealias CGPDFDictionaryRef = COpaquePointer
Objective C
typedef struct CGPDFDictionary *CGPDFDictionaryRef;
Оператор импорта
Objective C
@import CoreGraphics;
Swift
import CoreGraphics
Доступность
Доступный в iOS 2.0 и позже.