Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылка платформы ApplicationServices ссылка CGPDFArray

Опции
Развертывание Target:

На этой странице
Язык:

Ссылка CGPDFArray

Наследование


Не применимый

Соответствует


Не применимый

Оператор импорта


Swift

import CoreGraphics

Objective C

@import CoreGraphics;

Заголовочный файл CGPDFArray определяет непрозрачный тип, инкапсулирующий массив PDF. Массив PDF представляет структуру массива в документе в формате PDF. Массивы PDF могут быть неоднородными — т.е. они могут содержать любые другие объекты PDF, включая строки PDF, словари PDF и другие массивы PDF.

Много функций CGPDFArray для получения значений от массива PDF принимают форму:

  • bool CGPDFArrayGet<DataType> (
  • CGPDFArrayRef array,
  • size_t index,
  • <DataType>Ref *value
  • );

Эти функции тестируют тип данных объекта в указанном индексе. Если объект не имеет ожидаемого типа, функциональных возвратов false. Если объект имеет ожидаемый тип, функциональные возвраты true, и объект пасуется назад в value параметр.

Этот непрозрачный тип не получен из CFType и поэтому нет никаких функций для сохранения и выпуска его. Объекты CGPDFArray существуют только как составные части объекта CGPDFDocument, и ими управляет их контейнер.

Функции

  • Возвраты, является ли объект в данном индексе в массиве PDF другим массивом PDF и, если так, получают тот массив.

    Объявление

    Swift

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

    Objective C

    bool CGPDFArrayGetArray ( CGPDFArrayRef array, size_t index, CGPDFArrayRef *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на массив PDF. Если значение в указанном индексе является массивом PDF, то по возврату, которые выстраивают, иначе значение является неуказанным.

    Возвращаемое значение

    Возвраты true если существует массив PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF булевской переменной PDF и, если так, получают ту булевскую переменную.

    Объявление

    Swift

    func CGPDFArrayGetBoolean(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFBoolean>) -> Bool

    Objective C

    bool CGPDFArrayGetBoolean ( CGPDFArrayRef array, size_t index, CGPDFBoolean *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства array (0 к N-1, где N количество array), поведение не определено.

    value

    На вводе, указателе на булевскую переменную PDF. Если значение в указанном индексе является булевской переменной PDF, то по возврату, что булевская переменная, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует булевская переменная PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвращает число элементов в массиве PDF.

    Объявление

    Swift

    func CGPDFArrayGetCount(_ array: CGPDFArrayRef) -> Int

    Objective C

    size_t CGPDFArrayGetCount ( CGPDFArrayRef array );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    Возвращаемое значение

    Возвращает число элементов в массиве.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF словарем PDF и, если так, получают тот словарь.

    Объявление

    Swift

    func CGPDFArrayGetDictionary(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFDictionaryRef>) -> Bool

    Objective C

    bool CGPDFArrayGetDictionary ( CGPDFArrayRef array, size_t index, CGPDFDictionaryRef *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на словарь PDF. Если значение в указанном индексе является словарем PDF, то по возврату, что словарь, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует словарь PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF целым числом PDF и, если так, получают тот объект.

    Объявление

    Swift

    func CGPDFArrayGetInteger(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFInteger>) -> Bool

    Objective C

    bool CGPDFArrayGetInteger ( CGPDFArrayRef array, size_t index, CGPDFInteger *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на целое число PDF. Если значение в указанном индексе является целочисленным значением PDF, то по возврату содержит то значение, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует целое число PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF ссылкой имени PDF (представленный как постоянная струна до) и, если так, получают то имя.

    Объявление

    Swift

    func CGPDFArrayGetName(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<UnsafePointer<Int8>>) -> Bool

    Objective C

    bool CGPDFArrayGetName ( CGPDFArrayRef array, size_t index, const char **value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    Неинициализированный указатель на постоянную струну до. Если значение в указанном индексе является ссылкой на имя PDF (представленный постоянной струной до) тогда по возврату, содержит то значение; иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует массив символов в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в Кварце массив PDF нулем PDF.

    Объявление

    Swift

    func CGPDFArrayGetNull(_ array: CGPDFArrayRef, _ index: Int) -> Bool

    Objective C

    bool CGPDFArrayGetNull ( CGPDFArrayRef array, size_t index );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    Возвращаемое значение

    Возвраты true если существует нуль PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF числом PDF и, если так, получают тот объект.

    Объявление

    Swift

    func CGPDFArrayGetNumber(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFReal>) -> Bool

    Objective C

    bool CGPDFArrayGetNumber ( CGPDFArrayRef array, size_t index, CGPDFReal *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на число PDF. Если значение в указанном индексе является числом PDF, то по возврату содержит то значение, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует число PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF объектом PDF и, если так, получают тот объект.

    Объявление

    Swift

    func CGPDFArrayGetObject(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFObjectRef>) -> Bool

    Objective C

    bool CGPDFArrayGetObject ( CGPDFArrayRef array, size_t index, CGPDFObjectRef *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на объект PDF. Если значение в указанном индексе является объектом PDF, то по возврату содержит тот объект, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует объект PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF потоком PDF и, если так, получают тот поток.

    Объявление

    Swift

    func CGPDFArrayGetStream(_ array: CGPDFArrayRef, _ index: Int, _ value: UnsafeMutablePointer<CGPDFStreamRef>) -> Bool

    Objective C

    bool CGPDFArrayGetStream ( CGPDFArrayRef array, size_t index, CGPDFStreamRef *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на поток PDF. Если значение в указанном индексе является потоком PDF, то по возврату, что поток, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует поток PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

  • Возвраты, является ли объект в данном индексе в массиве PDF строкой PDF и, если так, получают ту строку.

    Объявление

    Swift

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

    Objective C

    bool CGPDFArrayGetString ( CGPDFArrayRef array, size_t index, CGPDFStringRef *value );

    Параметры

    array

    Массив PDF. Если этот параметр не является допустимым массивом PDF, поведение не определено.

    index

    Индекс значения для получения. Если индекс вне индексного пространства массива (0 к N-1, где N количество массива), поведение не определено.

    value

    На вводе, указателе на строку PDF. Если значение в указанном индексе является строкой PDF, то по возврату, которые представляют в виде строки, иначе значение не определено.

    Возвращаемое значение

    Возвраты true если существует поток PDF в указанном индексе, иначе false.

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.

Типы данных

  • Непрозрачный тип, инкапсулирующий массив PDF.

    Объявление

    Swift

    typealias CGPDFArrayRef = COpaquePointer

    Objective C

    typedef struct CGPDFArray *CGPDFArrayRef;

    Оператор импорта

    Objective C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Доступность

    Доступный в iOS 2.0 и позже.