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

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

Разработчик

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

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

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

NSError

NSError объект инкапсулирует более богатый и больше расширяемой информации об ошибке, чем возможное использование только код ошибки или строка ошибки. Базовые атрибуты NSError объект является ошибочным доменом (представленный строкой), проблемно-ориентированный код ошибки и пользовательский информационный словарь, содержащий специализированную информацию.

Несколько известных доменов определяются, соответствуя Маху, POSIX, и OSStatus ошибки. Коды ошибки основы найдены в ошибочном домене Какао и задокументированы в Ссылку Констант Основы. Кроме того, NSError позволяет Вам присоединять произвольный пользовательский информационный словарь к ошибочному объекту и обеспечивает средние значения для возврата человекочитаемого описания для ошибки.

NSError не абстрактный класс и может использоваться непосредственно. Приложения могут принять решение создать подклассы NSError обеспечить лучше локализованные строки ошибки путем переопределения localizedDescription.

В целом метод должен сигнализировать состояние ошибки — например — возврат NOfalse или nil вместо простым присутствием ошибочного объекта. Метод может тогда дополнительно возвратиться NSError объект ссылкой, для дальнейшего описания ошибки.

NSError бесплатный соединенный мостом с его Базовым дубликатом Основы, CFErrorRef. Посмотрите Бесплатное Образование моста для получения дополнительной информации.

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

Доступный в OS X v10.2 с установленным Safari 1.0.
Доступный в OS X v10.2.7 и позже.

Создание ошибочных объектов
  • errorWithDomain:code:userInfo: + errorWithDomain:code:userInfo:

    Создает и инициализирует NSError объект для данного домена и кода с данным userInfo словарь.

    Объявление

    Objective C

    + (instancetype)errorWithDomain:(NSString *)domain code:(NSInteger)code userInfo:(NSDictionary *)dict

    Параметры

    domain

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

    code

    Код ошибки для ошибки.

    dict

    userInfo словарь для ошибки. userInfo может быть nil.

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

    NSError объект для domain с указанной ошибкой code и словарь произвольных данных userInfo.

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

    Objective C

    @import Foundation;

    Доступность

    Доступный в OS X v10.2 с установленным Safari 1.0.

    Доступный в OS X v10.2.7 и позже.

  • init (domain:code:userInfo:) - initWithDomain:code:userInfo: Определяемый инициализатор

    Возвраты NSError объект, инициализированный для данного домена и кода с данным userInfo словарь.

    Объявление

    Swift

    init(domain domain: String, code code: Int, userInfo dict: [NSObject : AnyObject]?)

    Objective C

    - (instancetype)initWithDomain:(NSString *)domain code:(NSInteger)code userInfo:(NSDictionary *)dict

    Параметры

    domain

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

    code

    Код ошибки для ошибки.

    dict

    userInfo словарь для ошибки. userInfo может быть nil.

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

    NSError объект, инициализированный для domain с указанной ошибкой code и словарь произвольных данных userInfo.

    Обсуждение

    Это - определяемый инициализатор для NSError.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 с установленным Safari 1.0.

    Доступный в OS X v10.2.7 и позже.

    См. также

    + errorWithDomain:code:userInfo:

Получение ошибочных свойств
  • код код Свойство

    Код ошибки. (только для чтения)

    Объявление

    Swift

    var code: Int { get }

    Objective C

    @property(readonly) NSInteger code

    Обсуждение

    Обратите внимание на то, что ошибки являются зависящими от домена.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 с установленным Safari 1.0.

    Доступный в OS X v10.2.7 и позже.

    См. также

    – localizedDescription
    – домен
    – userInfo

  • домен домен Свойство

    Строка, содержащая ошибочный домен. (только для чтения)

    Объявление

    Swift

    var domain: String { get }

    Objective C

    @property(readonly, copy) NSString *domain

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 с установленным Safari 1.0.

    Доступный в OS X v10.2.7 и позже.

    См. также

    – код
    – localizedDescription
    – userInfo

  • userInfo userInfo Свойство

    Пользовательский информационный словарь. (только для чтения)

    Объявление

    Swift

    var userInfo: [NSObject : AnyObject]? { get }

    Objective C

    @property(readonly, copy) NSDictionary *userInfo

    Обсуждение

    Если пользовательский информационный словарь не был установлен, это свойство nil.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 с установленным Safari 1.0.

    Доступный в OS X v10.2.7 и позже.

    См. также

    – код
    – домен
    – localizedDescription

Получение локализованного описания ошибки
  • localizedDescription localizedDescription Свойство

    Строка, содержащая локализованное описание ошибки. (только для чтения)

    Объявление

    Swift

    var localizedDescription: String { get }

    Objective C

    @property(readonly, copy) NSString *localizedDescription

    Обсуждение

    Объект в пользовательском информационном словаре для ключа NSLocalizedDescriptionKey. Если пользовательский информационный словарь не содержит значение для NSLocalizedDescriptionKey, строка по умолчанию создается из домена и кода.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.2 с установленным Safari 1.0.

    Доступный в OS X v10.2.7 и позже.

    См. также

    – код
    – домен
    – userInfo

  • localizedRecoveryOptions localizedRecoveryOptions Свойство

    Массив, содержащий локализованные заголовки кнопок, подходящих для отображения в предупредительной панели. (только для чтения)

    Объявление

    Swift

    var localizedRecoveryOptions: [AnyObject]? { get }

    Objective C

    @property(readonly, copy) NSArray *localizedRecoveryOptions

    Обсуждение

    Объект в пользовательском информационном словаре для ключа NSLocalizedRecoveryOptionsErrorKey. Если пользовательский информационный словарь не содержит значение для NSLocalizedRecoveryOptionsErrorKey, это свойство nil.

    Первая строка является заголовком самой правой и кнопки по умолчанию, второе то налево от этого, и т.д. Опции восстановления должны быть подходящими для localizedRecoverySuggestion свойство. Если пользовательский информационный словарь не содержит значение для NSLocalizedRecoveryOptionsErrorKey, только кнопка OK выведена на экран.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.4 и позже.

  • localizedRecoverySuggestion localizedRecoverySuggestion Свойство

    Строка, содержащая локализованное предложение восстановления для ошибки. (только для чтения)

    Объявление

    Swift

    var localizedRecoverySuggestion: String? { get }

    Objective C

    @property(readonly, copy) NSString *localizedRecoverySuggestion

    Обсуждение

    Объект в пользовательском информационном словаре для ключа NSLocalizedRecoverySuggestionErrorKey. Если пользовательский информационный словарь не содержит значение для NSLocalizedRecoverySuggestionErrorKey, это свойство nil.

    Возвращаемая строка подходит для отображения как вторичное сообщение в предупредительной панели.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.4 и позже.

  • localizedFailureReason localizedFailureReason Свойство

    Строка, содержащая локализованное объяснение причины ошибки. (только для чтения)

    Объявление

    Swift

    var localizedFailureReason: String? { get }

    Objective C

    @property(readonly, copy) NSString *localizedFailureReason

    Обсуждение

    Объект в пользовательском информационном словаре для ключа NSLocalizedFailureReasonErrorKey.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – код
    – домен
    – userInfo

Получение восстановления после ошибки Attempter
  • recoveryAttempter recoveryAttempter Свойство

    Объект, соответствующий NSErrorRecoveryAttempting неофициальный протокол. (только для чтения)

    Объявление

    Swift

    var recoveryAttempter: AnyObject? { get }

    Objective C

    @property(readonly, retain) id recoveryAttempter

    Обсуждение

    Объект в пользовательском информационном словаре для ключа NSRecoveryAttempterErrorKey. Если пользовательский информационный словарь не содержит значение для NSRecoveryAttempterErrorKey, это свойство nil.

    Восстановление attempter должно быть объектом, который может правильно интерпретировать индекс в localizedRecoveryOptions свойство.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    localizedRecoveryOptions

Отображение привязки к справке
  • helpAnchor helpAnchor Свойство

    Строка для отображения в ответ на предупредительную панель помогает нажимаемой кнопке привязки. (только для чтения)

    Объявление

    Swift

    var helpAnchor: String? { get }

    Objective C

    @property(readonly, copy) NSString *helpAnchor

    Обсуждение

    Объект в пользовательском информационном словаре для ключа NSHelpAnchorErrorKey. Если пользовательский информационный словарь не содержит значение для NSHelpAnchorErrorKey, это свойство nil.

    Если это свойство не -nil для ошибки, будучи представленным alertWithError:, предупредительная панель будет включать кнопку привязки справки, которая может вывести на экран эту строку.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

    Доступный в OS X v10.6 и позже.

Константы
  • Пользовательские информационные ключи словаря

    Эти ключи могут существовать в пользовательском информационном словаре.

    Объявление

    Swift

    let NSLocalizedDescriptionKey: NSString! let NSFilePathErrorKey: NSString! let NSStringEncodingErrorKey: NSString! let NSUnderlyingErrorKey: NSString! let NSURLErrorKey: NSString! let NSLocalizedFailureReasonErrorKey: NSString! let NSLocalizedRecoverySuggestionErrorKey: NSString! let NSLocalizedRecoveryOptionsErrorKey: NSString! let NSRecoveryAttempterErrorKey: NSString! let NSHelpAnchorErrorKey: NSString! let NSURLErrorFailingURLErrorKey: NSString! let NSURLErrorFailingURLStringErrorKey: NSString! let NSURLErrorFailingURLPeerTrustErrorKey: NSString!

    Objective C

    NSString * const NSLocalizedDescriptionKey; NSString * const NSErrorFailingURLStringKey; NSString * const NSFilePathErrorKey; NSString * const NSStringEncodingErrorKey; NSString * const NSUnderlyingErrorKey; NSString * const NSURLErrorKey; NSString * const NSLocalizedFailureReasonErrorKey; NSString * const NSLocalizedRecoverySuggestionErrorKey; NSString * const NSLocalizedRecoveryOptionsErrorKey; NSString * const NSRecoveryAttempterErrorKey; NSString * const NSHelpAnchorErrorKey; NSString * const NSURLErrorFailingURLErrorKey; NSString * const NSURLErrorFailingURLStringErrorKey; NSString * const NSURLErrorFailingURLPeerTrustErrorKey;

    Константы

    • NSLocalizedDescriptionKey

      NSLocalizedDescriptionKey

      Соответствующее значение является представлением локализованной строки ошибки, которой, если есть будет возвращен localizedDescription.

      Доступный в OS X v10.2 и позже.

    • NSErrorFailingURLStringKey

      NSErrorFailingURLStringKey

      Соответствующим значением является URL, вызвавший ошибку. Этот ключ только присутствует в NSURLErrorDomain.

      Эта константа осуждается в OS X v10.6 и заменяется NSURLErrorFailingURLStringErrorKey.

      Эта константа осуждается в OS X v10.6 и заменяется NSURLErrorFailingURLStringErrorKey. Обе константы относятся к тому же значению для прежней совместимости, но новое имя символа имеет лучший префикс.

      Доступный в OS X v10.2 с установленным Safari 1.0.

      Доступный в OS X v10.2.7 и позже.

      Осуждаемый в OS X v10.6.

    • NSFilePathErrorKey

      NSFilePathErrorKey

      Содержит путь к файлу ошибки.

      Соответствующее значение NSString объект.

      Доступный в OS X v10.4 и позже.

    • NSStringEncodingErrorKey

      NSStringEncodingErrorKey

      Соответствующее значение NSNumber объект, содержащий NSStringEncoding значение.

      Доступный в OS X v10.4 и позже.

    • NSUnderlyingErrorKey

      NSUnderlyingErrorKey

      Соответствующее значение является ошибкой, с которой встретились в конкретной реализации и вызвала ошибку, которую получатель представляет для появления.

      Доступный в OS X v10.3 и позже.

    • NSURLErrorKey

      NSURLErrorKey

      Соответствующее значение NSURL объект.

      Доступный в OS X v10.4 и позже.

    • NSLocalizedFailureReasonErrorKey

      NSLocalizedFailureReasonErrorKey

      Соответствующее значение является представлением локализованной строки, содержащим причину отказа, что, если есть будет возвращен localizedFailureReason.

      Доступный в OS X v10.4 и позже.

    • NSLocalizedRecoverySuggestionErrorKey

      NSLocalizedRecoverySuggestionErrorKey

      Соответствующее значение является строкой, содержащей локализованное предложение восстановления для ошибки.

      Эта строка подходит для отображения как вторичное сообщение в предупредительной панели.

      Доступный в OS X v10.4 и позже.

    • NSLocalizedRecoveryOptionsErrorKey

      NSLocalizedRecoveryOptionsErrorKey

      Соответствующее значение является массивом, содержащим локализованные заголовки кнопок, подходящих для отображения в предупредительной панели.

      Первая строка является заголовком самой правой и кнопки по умолчанию, второе то налево, и т.д. Опции восстановления должны быть подходящими для предложения восстановления, возвращенного localizedRecoverySuggestion.

      Доступный в OS X v10.4 и позже.

    • NSRecoveryAttempterErrorKey

      NSRecoveryAttempterErrorKey

      Соответствующее значение является объектом, соответствующим NSErrorRecoveryAttempting неофициальный протокол.

      Восстановление attempter должно быть объектом, который может правильно интерпретировать индекс в массив, возвращенный recoveryAttempter.

      Доступный в OS X v10.4 и позже.

    • NSHelpAnchorErrorKey

      NSHelpAnchorErrorKey

      Соответствующее значение NSString содержа локализованную справку, соответствующую кнопке справки. Посмотрите helpAnchor для получения дополнительной информации.

      Доступный в OS X v10.6 и позже.

    • NSURLErrorFailingURLErrorKey

      NSURLErrorFailingURLErrorKey

      Соответствующее значение NSURL содержа URL, заставивший загрузку перестать работать. Этот ключ только присутствует в NSURLErrorDomain.

      Доступный в OS X v10.6 и позже.

    • NSURLErrorFailingURLStringErrorKey

      NSURLErrorFailingURLStringErrorKey

      Соответствующее значение NSString объект для URL, заставившего загрузку перестать работать. Этот ключ только присутствует в NSURLErrorDomain.

      Эта константа заменяет NSErrorFailingURLStringKey, который осуждался в OS X v10.6. Обе константы относятся к тому же значению для прежней совместимости, но это имя символа имеет лучший префикс.

      Доступный в OS X v10.6 и позже.

    • NSURLErrorFailingURLPeerTrustErrorKey

      NSURLErrorFailingURLPeerTrustErrorKey

      Соответствующее значение SecTrustRef объект, представляющий состояние неработающего квитирования SSL. Этот ключ только присутствует в NSURLErrorDomain.

      Доступный в OS X v10.6 и позже.

  • Ошибочные домены

    Следующие ошибочные домены предопределены.

    Объявление

    Swift

    let NSPOSIXErrorDomain: NSString! let NSOSStatusErrorDomain: NSString! let NSMachErrorDomain: NSString!

    Objective C

    NSString * const NSPOSIXErrorDomain; NSString * const NSOSStatusErrorDomain; NSString * const NSMachErrorDomain;

    Константы

    • NSPOSIXErrorDomain

      NSPOSIXErrorDomain

      Ошибки POSIX/BSD

      Доступный в OS X v10.2 и позже.

    • NSOSStatusErrorDomain

      NSOSStatusErrorDomain

      Mac OS 9/углеродов ошибок

      Доступный в OS X v10.2 и позже.

    • NSMachErrorDomain

      NSMachErrorDomain

      Ошибки Маха

      Доступный в OS X v10.2 и позже.

    Обсуждение

    Кроме того, следующий ошибочный домен определяется Базовой Основой: