One Logo Pool Ball
X
Github
Discord

System

Foundation · IOS API REFERENCE

CocoaError

struct · iOS 8.0+ · SDK 27.1

struct CocoaError

Describes errors within the Cocoa error domain, including errors that Foundation throws.

Members (103)

get · iOS 8.0+

formattingError

TypeScript
static get formattingError(): CocoaError_Code
Swift declaration
static var formattingError: CocoaError.Code { get }
get · iOS 8.0+

fileLockingError

TypeScript
static get fileLockingError(): CocoaError_Code
Swift declaration
static var fileLockingError: CocoaError.Code { get }
get · iOS 8.0+

isExecutableError

TypeScript
get isExecutableError(): boolean
Swift declaration
var isExecutableError: Bool { get }
get · iOS 8.0+

isFormattingError

TypeScript
get isFormattingError(): boolean
Swift declaration
var isFormattingError: Bool { get }
get · iOS 8.0+

isValidationError

TypeScript
get isValidationError(): boolean
Swift declaration
var isValidationError: Bool { get }
get · iOS 8.0+

userCancelledError

TypeScript
static get userCancelledError(): CocoaError_Code
Swift declaration
static var userCancelledError: CocoaError.Code { get }
get · iOS 8.0+

executableLinkError

TypeScript
static get executableLinkError(): CocoaError_Code
Swift declaration
static var executableLinkError: CocoaError.Code { get }
get · iOS 8.0+

executableLoadError

TypeScript
static get executableLoadError(): CocoaError_Code
Swift declaration
static var executableLoadError: CocoaError.Code { get }
get · iOS 8.0+

fileNoSuchFileError

TypeScript
static get fileNoSuchFileError(): CocoaError_Code
Swift declaration
static var fileNoSuchFileError: CocoaError.Code { get }
get · iOS 8.0+

isPropertyListError

TypeScript
get isPropertyListError(): boolean
Swift declaration
var isPropertyListError: Bool { get }
get · iOS 8.0+

isUserActivityError

TypeScript
get isUserActivityError(): boolean
Swift declaration
var isUserActivityError: Bool { get }
get · iOS 8.0+

fileReadUnknownError

TypeScript
static get fileReadUnknownError(): CocoaError_Code
Swift declaration
static var fileReadUnknownError: CocoaError.Code { get }
get · iOS 8.0+

isXPCConnectionError

TypeScript
get isXPCConnectionError(): boolean
Swift declaration
var isXPCConnectionError: Bool { get }
get · iOS 9.0+

coderReadCorruptError

TypeScript
static get coderReadCorruptError(): CocoaError_Code
Swift declaration
static var coderReadCorruptError: CocoaError.Code { get }
get · iOS 8.0+

fileReadTooLargeError

TypeScript
static get fileReadTooLargeError(): CocoaError_Code
Swift declaration
static var fileReadTooLargeError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteUnknownError

TypeScript
static get fileWriteUnknownError(): CocoaError_Code
Swift declaration
static var fileWriteUnknownError: CocoaError.Code { get }
get · iOS 8.0+

isUbiquitousFileError

TypeScript
get isUbiquitousFileError(): boolean
Swift declaration
var isUbiquitousFileError: Bool { get }
get · iOS 9.0+

coderValueNotFoundError

TypeScript
static get coderValueNotFoundError(): CocoaError_Code
Swift declaration
static var coderValueNotFoundError: CocoaError.Code { get }
get · iOS 8.0+

featureUnsupportedError

TypeScript
static get featureUnsupportedError(): CocoaError_Code
Swift declaration
static var featureUnsupportedError: CocoaError.Code { get }
get · iOS 8.0+

fileReadNoSuchFileError

TypeScript
static get fileReadNoSuchFileError(): CocoaError_Code
Swift declaration
static var fileReadNoSuchFileError: CocoaError.Code { get }
get · iOS 8.0+

keyValueValidationError

TypeScript
static get keyValueValidationError(): CocoaError_Code
Swift declaration
static var keyValueValidationError: CocoaError.Code { get }
get · iOS 8.0+

fileReadCorruptFileError

TypeScript
static get fileReadCorruptFileError(): CocoaError_Code
Swift declaration
static var fileReadCorruptFileError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteFileExistsError

TypeScript
static get fileWriteFileExistsError(): CocoaError_Code
Swift declaration
static var fileWriteFileExistsError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteOutOfSpaceError

TypeScript
static get fileWriteOutOfSpaceError(): CocoaError_Code
Swift declaration
static var fileWriteOutOfSpaceError: CocoaError.Code { get }
get · iOS 8.0+

fileReadNoPermissionError

TypeScript
static get fileReadNoPermissionError(): CocoaError_Code
Swift declaration
static var fileReadNoPermissionError: CocoaError.Code { get }
get · iOS 8.0+

executableNotLoadableError

TypeScript
static get executableNotLoadableError(): CocoaError_Code
Swift declaration
static var executableNotLoadableError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteNoPermissionError

TypeScript
static get fileWriteNoPermissionError(): CocoaError_Code
Swift declaration
static var fileWriteNoPermissionError: CocoaError.Code { get }
get · iOS 8.0+

propertyListReadStreamError

TypeScript
static get propertyListReadStreamError(): CocoaError_Code
Swift declaration
static var propertyListReadStreamError: CocoaError.Code { get }
get · iOS 8.0+

fileReadInvalidFileNameError

TypeScript
static get fileReadInvalidFileNameError(): CocoaError_Code
Swift declaration
static var fileReadInvalidFileNameError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteVolumeReadOnlyError

TypeScript
static get fileWriteVolumeReadOnlyError(): CocoaError_Code
Swift declaration
static var fileWriteVolumeReadOnlyError: CocoaError.Code { get }
get · iOS 8.0+

propertyListReadCorruptError

TypeScript
static get propertyListReadCorruptError(): CocoaError_Code
Swift declaration
static var propertyListReadCorruptError: CocoaError.Code { get }
get · iOS 8.0+

propertyListWriteStreamError

TypeScript
static get propertyListWriteStreamError(): CocoaError_Code
Swift declaration
static var propertyListWriteStreamError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteInvalidFileNameError

TypeScript
static get fileWriteInvalidFileNameError(): CocoaError_Code
Swift declaration
static var fileWriteInvalidFileNameError: CocoaError.Code { get }
get · iOS 8.0+

propertyListWriteInvalidError

TypeScript
static get propertyListWriteInvalidError(): CocoaError_Code
Swift declaration
static var propertyListWriteInvalidError: CocoaError.Code { get }
get · iOS 8.0+

executableRuntimeMismatchError

TypeScript
static get executableRuntimeMismatchError(): CocoaError_Code
Swift declaration
static var executableRuntimeMismatchError: CocoaError.Code { get }
get · iOS 8.0+

fileReadUnsupportedSchemeError

TypeScript
static get fileReadUnsupportedSchemeError(): CocoaError_Code
Swift declaration
static var fileReadUnsupportedSchemeError: CocoaError.Code { get }
get · iOS 8.0+

ubiquitousFileUnavailableError

TypeScript
static get ubiquitousFileUnavailableError(): CocoaError_Code
Swift declaration
static var ubiquitousFileUnavailableError: CocoaError.Code { get }
get · iOS 8.0+

userActivityHandoffFailedError

TypeScript
static get userActivityHandoffFailedError(): CocoaError_Code
Swift declaration
static var userActivityHandoffFailedError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteUnsupportedSchemeError

TypeScript
static get fileWriteUnsupportedSchemeError(): CocoaError_Code
Swift declaration
static var fileWriteUnsupportedSchemeError: CocoaError.Code { get }
get · iOS 8.0+

fileReadUnknownStringEncodingError

TypeScript
static get fileReadUnknownStringEncodingError(): CocoaError_Code
Swift declaration
static var fileReadUnknownStringEncodingError: CocoaError.Code { get }
get · iOS 8.0+

executableArchitectureMismatchError

TypeScript
static get executableArchitectureMismatchError(): CocoaError_Code
Swift declaration
static var executableArchitectureMismatchError: CocoaError.Code { get }
get · iOS 8.0+

propertyListReadUnknownVersionError

TypeScript
static get propertyListReadUnknownVersionError(): CocoaError_Code
Swift declaration
static var propertyListReadUnknownVersionError: CocoaError.Code { get }
get · iOS 8.0+

userActivityConnectionUnavailableError

TypeScript
static get userActivityConnectionUnavailableError(): CocoaError_Code
Swift declaration
static var userActivityConnectionUnavailableError: CocoaError.Code { get }
get · iOS 8.0+

fileReadInapplicableStringEncodingError

TypeScript
static get fileReadInapplicableStringEncodingError(): CocoaError_Code
Swift declaration
static var fileReadInapplicableStringEncodingError: CocoaError.Code { get }
get · iOS 8.0+

fileWriteInapplicableStringEncodingError

TypeScript
static get fileWriteInapplicableStringEncodingError(): CocoaError_Code
Swift declaration
static var fileWriteInapplicableStringEncodingError: CocoaError.Code { get }
get · iOS 8.0+

ubiquitousFileNotUploadedDueToQuotaError

TypeScript
static get ubiquitousFileNotUploadedDueToQuotaError(): CocoaError_Code
Swift declaration
static var ubiquitousFileNotUploadedDueToQuotaError: CocoaError.Code { get }
get · iOS 8.0+

userActivityHandoffUserInfoTooLargeError

TypeScript
static get userActivityHandoffUserInfoTooLargeError(): CocoaError_Code
Swift declaration
static var userActivityHandoffUserInfoTooLargeError: CocoaError.Code { get }
get · iOS 8.0+

userActivityRemoteApplicationTimedOutError

TypeScript
static get userActivityRemoteApplicationTimedOutError(): CocoaError_Code
Swift declaration
static var userActivityRemoteApplicationTimedOutError: CocoaError.Code { get }
get · iOS 8.0+

isFileError

TypeScript
get isFileError(): boolean
Swift declaration
var isFileError: Bool { get }
get · iOS 9.0+

isCoderError

TypeScript
get isCoderError(): boolean
Swift declaration
var isCoderError: Bool { get }
get · iOS 8.0+

formatting

TypeScript
static get formatting(): CocoaError_Code
Swift declaration
static var formatting: CocoaError.Code { get }
get · iOS 8.0+

underlying

TypeScript
get underlying(): (NativeError) | null
Swift declaration
var underlying: (any Error)? { get }

The underlying error behind this error, if any.

get · iOS 8.0+

errorDomain

TypeScript
static get errorDomain(): string
Swift declaration
static var errorDomain: String { get }

The domain of the error.

get · iOS 8.0+

fileLocking

TypeScript
static get fileLocking(): CocoaError_Code
Swift declaration
static var fileLocking: CocoaError.Code { get }
get · iOS 8.0+

userCancelled

TypeScript
static get userCancelled(): CocoaError_Code
Swift declaration
static var userCancelled: CocoaError.Code { get }
get · iOS 8.0+

executableLink

TypeScript
static get executableLink(): CocoaError_Code
Swift declaration
static var executableLink: CocoaError.Code { get }
get · iOS 8.0+

executableLoad

TypeScript
static get executableLoad(): CocoaError_Code
Swift declaration
static var executableLoad: CocoaError.Code { get }
get · iOS 8.0+

fileNoSuchFile

TypeScript
static get fileNoSuchFile(): CocoaError_Code
Swift declaration
static var fileNoSuchFile: CocoaError.Code { get }
get · iOS 8.0+

stringEncoding

TypeScript
get stringEncoding(): (String_Encoding) | null
Swift declaration
var stringEncoding: String.Encoding? { get }

The string encoding associated with this error, if any.

get · iOS 8.0+

fileReadUnknown

TypeScript
static get fileReadUnknown(): CocoaError_Code
Swift declaration
static var fileReadUnknown: CocoaError.Code { get }
get · iOS 9.0+

coderReadCorrupt

TypeScript
static get coderReadCorrupt(): CocoaError_Code
Swift declaration
static var coderReadCorrupt: CocoaError.Code { get }
get · iOS 8.0+

fileReadTooLarge

TypeScript
static get fileReadTooLarge(): CocoaError_Code
Swift declaration
static var fileReadTooLarge: CocoaError.Code { get }
get · iOS 8.0+

fileWriteUnknown

TypeScript
static get fileWriteUnknown(): CocoaError_Code
Swift declaration
static var fileWriteUnknown: CocoaError.Code { get }
get · iOS 14.5+

underlyingErrors

TypeScript
get underlyingErrors(): Array<NativeError>
Swift declaration
var underlyingErrors: [any Error] { get }

A list of underlying errors, if any. It includes the values of both NSUnderlyingErrorKey and NSMultipleUnderlyingErrorsKey. If there are no underlying errors, returns an empty array.

get · iOS 8.0+

coderInvalidValue

TypeScript
static get coderInvalidValue(): CocoaError_Code
Swift declaration
static var coderInvalidValue: CocoaError.Code { get }
get · iOS 9.0+

coderValueNotFound

TypeScript
static get coderValueNotFound(): CocoaError_Code
Swift declaration
static var coderValueNotFound: CocoaError.Code { get }
get · iOS 8.0+

featureUnsupported

TypeScript
static get featureUnsupported(): CocoaError_Code
Swift declaration
static var featureUnsupported: CocoaError.Code { get }
get · iOS 8.0+

fileReadNoSuchFile

TypeScript
static get fileReadNoSuchFile(): CocoaError_Code
Swift declaration
static var fileReadNoSuchFile: CocoaError.Code { get }
get · iOS 8.0+

keyValueValidation

TypeScript
static get keyValueValidation(): CocoaError_Code
Swift declaration
static var keyValueValidation: CocoaError.Code { get }
get · iOS 8.0+

fileReadCorruptFile

TypeScript
static get fileReadCorruptFile(): CocoaError_Code
Swift declaration
static var fileReadCorruptFile: CocoaError.Code { get }
get · iOS 8.0+

fileWriteFileExists

TypeScript
static get fileWriteFileExists(): CocoaError_Code
Swift declaration
static var fileWriteFileExists: CocoaError.Code { get }
get · iOS 8.0+

fileWriteOutOfSpace

TypeScript
static get fileWriteOutOfSpace(): CocoaError_Code
Swift declaration
static var fileWriteOutOfSpace: CocoaError.Code { get }
get · iOS 8.0+

fileReadNoPermission

TypeScript
static get fileReadNoPermission(): CocoaError_Code
Swift declaration
static var fileReadNoPermission: CocoaError.Code { get }
get · iOS 8.0+

xpcConnectionInvalid

TypeScript
static get xpcConnectionInvalid(): CocoaError_Code
Swift declaration
static var xpcConnectionInvalid: CocoaError.Code { get }
get · iOS 8.0+

executableNotLoadable

TypeScript
static get executableNotLoadable(): CocoaError_Code
Swift declaration
static var executableNotLoadable: CocoaError.Code { get }
get · iOS 8.0+

fileWriteNoPermission

TypeScript
static get fileWriteNoPermission(): CocoaError_Code
Swift declaration
static var fileWriteNoPermission: CocoaError.Code { get }
get · iOS 8.0+

propertyListReadStream

TypeScript
static get propertyListReadStream(): CocoaError_Code
Swift declaration
static var propertyListReadStream: CocoaError.Code { get }
get · iOS 8.0+

fileReadInvalidFileName

TypeScript
static get fileReadInvalidFileName(): CocoaError_Code
Swift declaration
static var fileReadInvalidFileName: CocoaError.Code { get }
get · iOS 8.0+

fileWriteVolumeReadOnly

TypeScript
static get fileWriteVolumeReadOnly(): CocoaError_Code
Swift declaration
static var fileWriteVolumeReadOnly: CocoaError.Code { get }
get · iOS 8.0+

propertyListReadCorrupt

TypeScript
static get propertyListReadCorrupt(): CocoaError_Code
Swift declaration
static var propertyListReadCorrupt: CocoaError.Code { get }
get · iOS 8.0+

propertyListWriteStream

TypeScript
static get propertyListWriteStream(): CocoaError_Code
Swift declaration
static var propertyListWriteStream: CocoaError.Code { get }
get · iOS 8.0+

fileWriteInvalidFileName

TypeScript
static get fileWriteInvalidFileName(): CocoaError_Code
Swift declaration
static var fileWriteInvalidFileName: CocoaError.Code { get }
get · iOS 8.0+

propertyListWriteInvalid

TypeScript
static get propertyListWriteInvalid(): CocoaError_Code
Swift declaration
static var propertyListWriteInvalid: CocoaError.Code { get }
get · iOS 8.0+

xpcConnectionInterrupted

TypeScript
static get xpcConnectionInterrupted(): CocoaError_Code
Swift declaration
static var xpcConnectionInterrupted: CocoaError.Code { get }
get · iOS 8.0+

executableRuntimeMismatch

TypeScript
static get executableRuntimeMismatch(): CocoaError_Code
Swift declaration
static var executableRuntimeMismatch: CocoaError.Code { get }
get · iOS 8.0+

fileReadUnsupportedScheme

TypeScript
static get fileReadUnsupportedScheme(): CocoaError_Code
Swift declaration
static var fileReadUnsupportedScheme: CocoaError.Code { get }
get · iOS 8.0+

ubiquitousFileUnavailable

TypeScript
static get ubiquitousFileUnavailable(): CocoaError_Code
Swift declaration
static var ubiquitousFileUnavailable: CocoaError.Code { get }
get · iOS 8.0+

userActivityHandoffFailed

TypeScript
static get userActivityHandoffFailed(): CocoaError_Code
Swift declaration
static var userActivityHandoffFailed: CocoaError.Code { get }
get · iOS 8.0+

xpcConnectionReplyInvalid

TypeScript
static get xpcConnectionReplyInvalid(): CocoaError_Code
Swift declaration
static var xpcConnectionReplyInvalid: CocoaError.Code { get }
get · iOS 8.0+

fileWriteUnsupportedScheme

TypeScript
static get fileWriteUnsupportedScheme(): CocoaError_Code
Swift declaration
static var fileWriteUnsupportedScheme: CocoaError.Code { get }
get · iOS 8.0+

fileReadUnknownStringEncoding

TypeScript
static get fileReadUnknownStringEncoding(): CocoaError_Code
Swift declaration
static var fileReadUnknownStringEncoding: CocoaError.Code { get }
get · iOS 8.0+

executableArchitectureMismatch

TypeScript
static get executableArchitectureMismatch(): CocoaError_Code
Swift declaration
static var executableArchitectureMismatch: CocoaError.Code { get }
get · iOS 8.0+

propertyListReadUnknownVersion

TypeScript
static get propertyListReadUnknownVersion(): CocoaError_Code
Swift declaration
static var propertyListReadUnknownVersion: CocoaError.Code { get }
get · iOS 8.0+

userActivityConnectionUnavailable

TypeScript
static get userActivityConnectionUnavailable(): CocoaError_Code
Swift declaration
static var userActivityConnectionUnavailable: CocoaError.Code { get }
get · iOS 8.0+

fileReadInapplicableStringEncoding

TypeScript
static get fileReadInapplicableStringEncoding(): CocoaError_Code
Swift declaration
static var fileReadInapplicableStringEncoding: CocoaError.Code { get }
get · iOS 8.0+

fileWriteInapplicableStringEncoding

TypeScript
static get fileWriteInapplicableStringEncoding(): CocoaError_Code
Swift declaration
static var fileWriteInapplicableStringEncoding: CocoaError.Code { get }
get · iOS 8.0+

ubiquitousFileNotUploadedDueToQuota

TypeScript
static get ubiquitousFileNotUploadedDueToQuota(): CocoaError_Code
Swift declaration
static var ubiquitousFileNotUploadedDueToQuota: CocoaError.Code { get }
get · iOS 8.0+

userActivityHandoffUserInfoTooLarge

TypeScript
static get userActivityHandoffUserInfoTooLarge(): CocoaError_Code
Swift declaration
static var userActivityHandoffUserInfoTooLarge: CocoaError.Code { get }
get · iOS 8.0+

userActivityRemoteApplicationTimedOut

TypeScript
static get userActivityRemoteApplicationTimedOut(): CocoaError_Code
Swift declaration
static var userActivityRemoteApplicationTimedOut: CocoaError.Code { get }
get · iOS 8.0+

url

TypeScript
get url(): (string) | null
Swift declaration
var url: URL? { get }

The URL associated with this error, if any.

get · iOS 8.0+

ubiquitousFileUbiquityServerNotAvailable

TypeScript
static get ubiquitousFileUbiquityServerNotAvailable(): CocoaError_Code
Swift declaration
static var ubiquitousFileUbiquityServerNotAvailable: CocoaError.Code { get }
static · iOS 8.0+

error

TypeScript
static error(code: CocoaError_Code, userInfo?: (NativeMap<unknown, unknown>) | null, url?: (string) | null): NativeError
Swift declaration
static func error(_ code: CocoaError.Code, userInfo: [AnyHashable : Any]? = nil, url: URL? = nil) -> any Error
get · iOS 8.0+

filePath

TypeScript
get filePath(): (string) | null
Swift declaration
var filePath: String? { get }

The file path associated with the error, if any.

Skipped declarations

No declarations were skipped in this snapshot.

All Foundation types →