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

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

Разработчик

Ссылка платформы основы ссылка класса NSPropertyListSerialization

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

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

NSPropertyListSerialization

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


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


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


Swift

import Foundation

Objective C

@import Foundation;

Доступность


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

NSPropertyListSerialization класс обеспечивает методы, преобразовывающие объекты списка свойств в и от нескольких сериализованных форматов. Объекты списка свойств включают NSData, NSString, NSArray, NSDictionary, NSDate, и NSNumber объекты. Эти объекты бесплатные соединенный мостом с их соответствующими Базовыми типами Основы (CFData, CFString, и т.д.). Для больше о бесплатном образовании моста, посмотрите Взаимозаменяемые Типы данных.

  • Возвраты NSData объект, содержащий данный список свойств в указанном формате.

    Объявление

    Swift

    class func dataWithPropertyList(_ plist: AnyObject, format format: NSPropertyListFormat, options opt: NSPropertyListWriteOptions, error error: NSErrorPointer) -> NSData?

    Objective C

    + (NSData *)dataWithPropertyList:(id)plist format:(NSPropertyListFormat)format options:(NSPropertyListWriteOptions)opt error:(out NSError **)error

    Параметры

    plist

    Объект списка свойств. Передача nil поскольку это значение заставит исключение быть повышенным.

    format

    Формат списка свойств. Возможные значения для format описаны в NSPropertyListFormat.

    opt

    opt параметр в настоящее время не использован и должен быть установлен на 0.

    error

    Если метод не завершается успешно, по возврату содержит NSError объект, описывающий проблему.

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

    NSData объектный содержащий plist в формате, указанном format.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • Пишет указанный список свойств в указанный поток.

    Объявление

    Swift

    class func writePropertyList(_ plist: AnyObject, toStream stream: NSOutputStream, format format: NSPropertyListFormat, options opt: NSPropertyListWriteOptions, error error: NSErrorPointer) -> Int

    Objective C

    + (NSInteger)writePropertyList:(id)plist toStream:(NSOutputStream *)stream format:(NSPropertyListFormat)format options:(NSPropertyListWriteOptions)opt error:(out NSError **)error

    Параметры

    plist

    Объект списка свойств. Передача nil поскольку это значение заставит исключение быть повышенным.

    stream

    NSStream объект. Поток должен быть открыт и сконфигурирован для чтения.

    format

    Формат списка свойств. Возможные значения для format описаны в NSPropertyListFormat.

    opt

    opt параметр в настоящее время не использован и должен быть установлен на 0.

    error

    Если метод не завершается успешно, по возврату содержит NSError объект, описывающий проблему.

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

    Возвращает число байтов, записанных в поток. Если значение 0 ошибка произошла.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • Создает и возвращает список свойств из указанных данных.

    Объявление

    Swift

    class func propertyListWithData(_ data: NSData, options opt: NSPropertyListReadOptions, format format: UnsafeMutablePointer<NSPropertyListFormat>, error error: NSErrorPointer) -> AnyObject?

    Objective C

    + (id)propertyListWithData:(NSData *)data options:(NSPropertyListReadOptions)opt format:(NSPropertyListFormat *)format error:(out NSError **)error

    Параметры

    data

    Объект данных, содержащий сериализированный список свойств. Передача nil поскольку это значение заставит исключение быть повышенным.

    opt

    Опции могут быть любым из перечисленных в NSPropertyListMutabilityOptions.

    format

    По возврату, содержит формат, в котором был сохранен список свойств. Передача NULL если Вы не должны знать формат.

    error

    Если метод не завершается успешно, по возврату содержит NSError объект, описывающий проблему.

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

    Соответствие объекта списка свойств представлению в data. Если данные не находятся в поддерживаемом формате, возвратах nil.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • Создает и возвращает список свойств путем чтения из указанного потока.

    Объявление

    Swift

    class func propertyListWithStream(_ stream: NSInputStream, options opt: NSPropertyListReadOptions, format format: UnsafeMutablePointer<NSPropertyListFormat>, error error: NSErrorPointer) -> AnyObject?

    Objective C

    + (id)propertyListWithStream:(NSInputStream *)stream options:(NSPropertyListReadOptions)opt format:(NSPropertyListFormat *)format error:(out NSError **)error

    Параметры

    stream

    NSStream объект. Поток должен быть открыт и сконфигурирован для чтения.

    opt

    Набор к 0 — опции чтения не реализован.

    format

    По возврату, содержит формат, в котором был сохранен список свойств. Передача NULL если Вы не должны знать формат.

    error

    Если метод не завершается успешно, по возврату содержит NSError объект, описывающий проблему.

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

    Соответствие объекта списка свойств представлению в data. Если данные не находятся в поддерживаемом формате, возвратах nil.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

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

    Объявление

    Swift

    class func propertyList(_ plist: AnyObject, isValidForFormat format: NSPropertyListFormat) -> Bool

    Objective C

    + (BOOL)propertyList:(id)plist isValidForFormat:(NSPropertyListFormat)format

    Параметры

    plist

    Объект списка свойств.

    format

    Формат списка свойств. Возможные значения для format перечислены в NSPropertyListFormat.

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

    YEStrue если plist допустимый список свойств в формате format, иначе NOfalse.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • Этот метод является устаревшим и будет скоро осужден.

    Оператор осуждения

    Использовать dataWithPropertyList:format:options:error: вместо этого.

    Объявление

    Swift

    class func dataFromPropertyList(_ plist: AnyObject, format format: NSPropertyListFormat, errorDescription errorString: UnsafeMutablePointer<NSString?>) -> NSData?

    Objective C

    + (NSData *)dataFromPropertyList:(id)plist format:(NSPropertyListFormat)format errorDescription:(out NSString **)errorString

    Параметры

    plist

    Объект списка свойств.

    format

    Формат списка свойств. Возможные значения для format описаны в NSPropertyListFormat.

    errorString

    По возврату, если преобразование успешно, errorString nil. Если сбои преобразования, по возврату содержит строку, описывающую природу ошибки.

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

    NSData объектный содержащий plist в формате, указанном format.

    Специальные замечания

    Этот метод является устаревшим и будет скоро осужден. Использовать dataWithPropertyList:format:options:error: вместо этого.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    Осуждаемый в iOS 8.0.

  • Этот метод является устаревшим и будет скоро осужден.

    Оператор осуждения

    Использовать propertyListWithData:options:format:error: вместо этого.

    Объявление

    Swift

    class func propertyListFromData(_ data: NSData, mutabilityOption opt: NSPropertyListMutabilityOptions, format format: UnsafeMutablePointer<NSPropertyListFormat>, errorDescription errorString: UnsafeMutablePointer<NSString?>) -> AnyObject?

    Objective C

    + (id)propertyListFromData:(NSData *)data mutabilityOption:(NSPropertyListMutabilityOptions)opt format:(NSPropertyListFormat *)format errorDescription:(out NSString **)errorString

    Параметры

    data

    Объект данных, содержащий сериализированный список свойств.

    opt

    opt параметр в настоящее время не использован и должен быть установлен на 0.

    format

    Если список свойств допустим, по возврату содержит формат. format может быть NULL, когда не возвращается формат списка свойств. Возможные значения описаны в NSPropertyListFormat.

    errorString

    По возврату, если преобразование успешно, errorString nil. Если сбои преобразования, по возврату содержит строку, описывающую природу ошибки.

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

    Соответствие объекта списка свойств представлению в data. Если данные не находятся в поддерживаемом формате, возвратах nil.

    Специальные замечания

    Этот метод является устаревшим и будет скоро осужден. Использовать propertyListWithData:options:format:error: вместо этого.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    Осуждаемый в iOS 8.0.

Типы данных

  • Единственные поддерживаемые опции чтения описаны в NSPropertyListMutabilityOptions.

    Объявление

    Swift

    typealias NSPropertyListReadOptions = Int

    Objective C

    typedef NSUInteger NSPropertyListReadOptions;

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • Эти константы указывают опции переменчивости в списках свойств.

    Объявление

    Swift

    struct NSPropertyListMutabilityOptions : RawOptionSetType { init(_ rawValue: UInt) init(rawValue rawValue: UInt) static var Immutable: NSPropertyListMutabilityOptions { get } static var MutableContainers: NSPropertyListMutabilityOptions { get } static var MutableContainersAndLeaves: NSPropertyListMutabilityOptions { get } }

    Objective C

    enum { NSPropertyListImmutable = kCFPropertyListImmutable, NSPropertyListMutableContainers = kCFPropertyListMutableContainers, NSPropertyListMutableContainersAndLeaves = kCFPropertyListMutableContainersAndLeaves }; typedef NSUInteger NSPropertyListMutabilityOptions;

    Константы

    • Immutable

      NSPropertyListImmutable

      Заставляет возвращенный список свойств содержать неизменные объекты.

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

    • MutableContainers

      NSPropertyListMutableContainers

      Заставляет возвращенный список свойств иметь непостоянные контейнеры, но неизменные листы.

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

    • MutableContainersAndLeaves

      NSPropertyListMutableContainersAndLeaves

      Заставляет возвращенный список свойств иметь непостоянные контейнеры и листы.

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • Эти константы используются для указания формата сериализации списка свойств.

    Объявление

    Swift

    enum NSPropertyListFormat : UInt { case OpenStepFormat case XMLFormat_v1_0 case BinaryFormat_v1_0 }

    Objective C

    enum { NSPropertyListOpenStepFormat = kCFPropertyListOpenStepFormat, NSPropertyListXMLFormat_v1_0 = kCFPropertyListXMLFormat_v1_0, NSPropertyListBinaryFormat_v1_0 = kCFPropertyListBinaryFormat_v1_0 }; NSPropertyListFormat; typedef NSUInteger NSPropertyListFormat;

    Константы

    • OpenStepFormat

      NSPropertyListOpenStepFormat

      Указывает формат списка свойств ASCII, наследованный от OpenStep APIs.

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

    • XMLFormat_v1_0

      NSPropertyListXMLFormat_v1_0

      Указывает формат списка свойств XML.

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

    • BinaryFormat_v1_0

      NSPropertyListBinaryFormat_v1_0

      Указывает двоичный формат списка свойств.

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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