NSError NSError Class

Definition

Encapsulates an error.

[Foundation.Register("NSError", true)]
public class NSError : Foundation.NSObject, Foundation.INSCopying, Foundation.INSSecureCoding, IDisposable
type NSError = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSSecureCoding
Inheritance
Attributes
Implements

Remarks

NSError objects wrap both error domains, an error code and an optional error payload into one. The error domain is used to classify the error (typically, there is an error domain per susbsystem). There are several static properties in the NSError class that represent some common domains like the CocoaErrorDomain or the CFNetworkErrorDomain.

NSErrors can be serialized.

You can create an NSError with a domain by providing both parameters. The following example shows how to do this, and passes a payload:

var payload = NSDictionary.FromObjectsAndKeys (new object [] {1,2,3,4});

When creating the error with a payload, you can provide a number of optional elements that provide the user with more information. You should provide this information on the NSDictionary with the keys defined in this class like LocalizedFailureErrorKey, P:Foundation.NSError.FilePathErrorKey, HelpAnchorErrorKey, LocalizedDescriptionKey, LocalizedFailureReasonErrorKey, LocalizedRecoveryOptionsErrorKey, LocalizedRecoverySuggestionErrorKey, P:Foundation.NSError.StringEncodingErrorKey, UnderlyingErrorKey and P:Foundation.NSError.UrlErrorKey.

For example:

var userInfo = new NSDictionary (NSError.LocalizedDescriptionKey, "Error while parsing GeoJSON”);

The LocalizedDescription property will return the above value.

Constructors

NSError() NSError()

Do not use the Default Constructor unless you are dealing with a low-level API that will initialize the object for you.

NSError(IntPtr) NSError(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSError(NSCoder) NSError(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

NSError(NSObjectFlag) NSError(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

NSError(NSString, nint) NSError(NSString, nint)

A constructor that initializes the object with a specified domain and an error code.

NSError(NSString, nint, NSDictionary) NSError(NSString, nint, NSDictionary)

Properties

CFNetworkErrorDomain CFNetworkErrorDomain

The CFNetwork error domain.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

CocoaErrorDomain CocoaErrorDomain

The Cocoa error domain.

Code Code

The error code in this NSError

CoreLocationErrorDomain CoreLocationErrorDomain

The CoreLocation error domain.

CoreMotionErrorDomain CoreMotionErrorDomain

The CoreMotion error domain.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DebugDescriptionErrorKey DebugDescriptionErrorKey
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Domain Domain

The domain associated with this error.

EABluetoothAccessoryPickerErrorDomain EABluetoothAccessoryPickerErrorDomain

Represents the value associated with the constant EABluetoothAccessoryPickerErrorDomain

FilePathErrorKey FilePathErrorKey

Standard key to use in the userInfo payload for associating a file path with the error.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
HelpAnchor HelpAnchor

Returns the help anchor that was associated with this error (the payload contained a HelpAnchorErrorKey)

HelpAnchorErrorKey HelpAnchorErrorKey

Standard key to use in the userInfo payload for associating a hint to provide to the user.

IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
LocalizedDescription LocalizedDescription

Returns a localized description of the error.

LocalizedDescriptionKey LocalizedDescriptionKey

Standard key to use in the userInfo payload for associating a localized description of the problem to provide to the user.

LocalizedFailureErrorKey LocalizedFailureErrorKey
LocalizedFailureReason LocalizedFailureReason
LocalizedFailureReasonErrorKey LocalizedFailureReasonErrorKey

Represents the value associated with the constant NSLocalizedFailureReasonErrorKey

LocalizedRecoveryOptions LocalizedRecoveryOptions
LocalizedRecoveryOptionsErrorKey LocalizedRecoveryOptionsErrorKey

Represents the value associated with the constant NSLocalizedRecoveryOptionsErrorKey

LocalizedRecoverySuggestion LocalizedRecoverySuggestion
LocalizedRecoverySuggestionErrorKey LocalizedRecoverySuggestionErrorKey

Represents the value associated with the constant NSLocalizedRecoverySuggestionErrorKey

MachErrorDomain MachErrorDomain

Represents the value associated with the constant NSMachErrorDomain

MapKitErrorDomain MapKitErrorDomain

Represents the value associated with the constant MKErrorDomain

NSNetServicesErrorDomain NSNetServicesErrorDomain

Represents the value associated with the constant NSNetServicesErrorDomain

NSStreamSocketSSLErrorDomain NSStreamSocketSSLErrorDomain

Represents the value associated with the constant NSStreamSocketSSLErrorDomain

NSStreamSOCKSErrorDomain NSStreamSOCKSErrorDomain

Represents the value associated with the constant NSStreamSOCKSErrorDomain

NSUrlErrorDomain NSUrlErrorDomain

Represents the value associated with the constant NSURLErrorDomain

OsStatusErrorDomain OsStatusErrorDomain

Represents the value associated with the constant NSOSStatusErrorDomain

PosixErrorDomain PosixErrorDomain

Represents the value associated with the constant NSPOSIXErrorDomain

RecoveryAttempterErrorKey RecoveryAttempterErrorKey

Represents the value associated with the constant NSRecoveryAttempterErrorKey

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
StringEncodingErrorKey StringEncodingErrorKey

Represents the value associated with the constant NSStringEncodingErrorKey

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
UnderlyingErrorKey UnderlyingErrorKey

Represents the value associated with the constant NSUnderlyingErrorKey

UrlErrorKey UrlErrorKey

Represents the value associated with the constant NSURLErrorKey

UserInfo UserInfo

Returns the associated user-defined payload.

WatchKitErrorDomain WatchKitErrorDomain

The WatchKit error domain.

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
FromDomain(NSString, nint) FromDomain(NSString, nint)

Creates an NSError instance from a given domain and code.

FromDomain(NSString, nint, NSDictionary) FromDomain(NSString, nint, NSDictionary)
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetFileProviderError(INSFileProviderItem) GetFileProviderError(INSFileProviderItem)
GetFileProviderError(String) GetFileProviderError(String)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetUserInfoValueProvider(String) GetUserInfoValueProvider(String)
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetUserInfoValueProvider(String, NSErrorUserInfoValueProvider) SetUserInfoValueProvider(String, NSErrorUserInfoValueProvider)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also