Foundation Constants

Overview

This document defines constants in the Foundation framework that are not associated with a particular class.

Symbols

Enumerations

NSNotFound

Defines a value that indicates that an item requested couldn’t be found or doesn’t exist.

These constants are used as components in a bitfield to specify the behavior of NSAllocateCollectable and NSReallocateCollectable.

NSEnumerationOptions

Options for Block enumeration operations.

ComparisonResult

These constants are used to indicate how items in a request are ordered.

NSSortOptions

Options for Block sorting operations.

QualityOfService

Used to indicate the nature and importance of work to the system. Work with higher quality of service classes receive more resources than work with lower quality of service classes whenever there is resource contention.

FileManager.SearchPathDirectory

These constants specify the location of a variety of directories by the urls(for:in:) and url(for:in:appropriateFor:create:) FileManager methods.

FileManager.SearchPathDomainMask

Search path domain constants specifying base locations for the FileManager.SearchPathDirectory type. These constants are used by the urls(for:in:) and url(for:in:appropriateFor:create:) FileManager methods.

NSError Codes

NSError codes in the Cocoa error domain.

URL Loading System Error Codes

These values are returned as the error code property of an NSError object with the domain “NSURLErrorDomain”.

iCloud Error Codes

These error codes are used by error objects associated with the NSURLUbiquitousItemDownloadingErrorKey on an NSURL object when an iCloud-related error occurs.

XPC Errors

Errors returned by XPC connections. Note that these are not currently available on iOS.

Global Variables

Cocoa Error Domain

These constants defines the Cocoa error domain.

NSHashTable Callbacks

Predefined sets of callbacks for NSHashTable.

NSMapTable Key Call Backs

Predefined sets of callbacks for NSMapTable keys.

NSMapTable Value Callbacks

These are predefined sets of callbacks for NSMapTable values.

NSURL Domain

This error domain is defined for NSURL.

Zero Constants

These constants are defined as conveniences and can be used to compare with return values from functions.

Geometric Alignment

AlignmentOptions

These constants are used by the NSIntegralRectWithOptions(_:_:) function and other related methods, such as backingAlignedRect(_:options:).

Numeric Constants

NSDecimal Constants

Constants used by NSDecimal.

NSInteger and NSUInteger Maximum and Minimum Values

Constants representing the maximum and minimum values of NSInteger and NSUInteger.

Exceptions

General Exception Names

Exceptions defined by NSException.

Version Numbers

Foundation Version Number

Version of the Foundation framework in the current environment.

Foundation Framework Version Numbers

Constants to define Foundation Framework version numbers.

Constants

let NSAppleEventTimeOutDefault: Double

Specifies that an event-processing operation should continue until a timeout occurs based on a value determined by the Apple Event Manager (about 1 minute). Not currently used by applications.

let NSAppleEventTimeOutNone: Double

Specifies that the application is willing to wait indefinitely for the current operation to complete. Not currently used by applications.

let NSAssertionHandlerKey: String

let NSBuddhistCalendar: String

Identifier for the Buddhist calendar.

Deprecated

let NSBundleResourceRequestLoadingPriorityUrgent: Double

let NSChineseCalendar: String

Identifier for the Chinese calendar.

Deprecated

let NSEdgeInsetsZero: EdgeInsets

let NSErrorFailingURLStringKey: StringDeprecated

let NSExtensionItemAttachmentsKey: String

An optional array of media data associated with the extension item.

let NSExtensionItemAttributedContentTextKey: String

An optional string describing the extension item content.

let NSExtensionItemAttributedTitleKey: String

An optional title of the extension item.

let NSExtensionItemsAndErrorsKey: String

let NSExtensionJavaScriptFinalizeArgumentKey: String

A key whose value is an item of type kUTTypePropertyList. The item contains an NSDictionary that contains the arguments to be passed to a JavaScript finalize method.

let NSExtensionJavaScriptPreprocessingResultsKey: String

A key whose value is an item of type kUTTypePropertyList. The item contains an NSDictionary that contains the object returned by the JavaScript code to its completion function.

let NSFileHandleNotificationDataItem: String

A key in the userinfo dictionary in a readCompletionNotification and NSFileHandleReadToEndOfFileCompletion.

let NSFileHandleNotificationFileHandleItem: String

A key in the userinfo dictionary in a NSFileHandleConnectionAccepted notification.

let NSFileHandleNotificationMonitorModes: StringDeprecated

var NSFoundationVersionWithFileManagerResourceForkSupport: Int32

The version of the Foundation framework in which NSFileManager first supported resource forks.

let NSGrammarCorrections: String

The value for the NSGrammarCorrections key should be an NSArray of NSStrings representing potential substitutions to correct the problem, but it is expected that this may not be available in all cases. NSGrammarUserDescription or NSGrammarCorrections must be supplied in order for correction guidance to be presented to the user.

let NSGrammarRange: String

The value for the NSGrammarRange dictionary key should be an NSValue containing an NSRange, a subrange of the sentence range used as the return value, whose location should be an offset from the beginning of the sentence--so, for example, an NSGrammarRange for the first four characters of the overall sentence range should be {0, 4}. If the NSGrammarRange key is not present in the dictionary it is assumed to be equal to the overall sentence range.

let NSGrammarUserDescription: String

The value for the NSGrammarUserDescription dictionary key should be an NSString containing descriptive text about that range, to be presented directly to the user; it is intended that the user description should provide enough information to allow the user to correct the problem. It is recommended that NSGrammarUserDescription be supplied in all cases, however, NSGrammarUserDescription or NSGrammarCorrections must be supplied in order for correction guidance to be presented to the user.

let NSGregorianCalendar: String

Identifier for the Gregorian calendar.

Deprecated

let NSHashTableCopyIn: NSPointerFunctions.Optionslet NSHashTableObjectPointerPersonality: NSPointerFunctions.Optionslet NSHashTableStrongMemory: NSPointerFunctions.Optionslet NSHashTableWeakMemory: NSPointerFunctions.Options

let NSHebrewCalendar: String

Identifier for the Hebrew calendar.

Deprecated

let NSISO8601Calendar: String

Identifier for the ISO8601 calendar.

Deprecated

let NSIndianCalendar: String

Identifier for the Indian calendar.

Deprecated

let NSIslamicCalendar: String

Identifier for the Islamic calendar.

Deprecated

let NSIslamicCivilCalendar: String

Identifier for the Islamic civil calendar.

Deprecated

let NSItemProviderPreferredImageSizeKey: String

A key specifying the dimensions of an image in pixels. The value of this key is an NSValue object containing a CGSize or NSSize data type.

let NSJapaneseCalendar: String

Identifier for the Japanese calendar.

Deprecated

let NSKeyedArchiveRootObjectKey: String

Archives created using the class method archivedData(withRootObject:) use this key for the root object in the hierarchy of encoded objects. The NSKeyedUnarchiver class method unarchiveObject(with:) looks for this root key as well.

let NSLinguisticTagAdjective: String

This token is an adjective

let NSLinguisticTagAdverb: String

This token is an adverb.

let NSLinguisticTagClassifier: String

This token is a classifier.

let NSLinguisticTagCloseParenthesis: String

This token is a close parenthesis.

let NSLinguisticTagCloseQuote: String

This token is a close quote.

let NSLinguisticTagConjunction: String

This token is a conjunction.

let NSLinguisticTagDash: String

This token is a dash.

let NSLinguisticTagDeterminer: String

This token is a determiner.

let NSLinguisticTagIdiom: String

This token is an idiom.

let NSLinguisticTagInterjection: String

This token is an interjection.

let NSLinguisticTagNoun: String

The token is a noun.

let NSLinguisticTagNumber: String

This token is a number.

let NSLinguisticTagOpenParenthesis: String

This token is an open parenthesis.

let NSLinguisticTagOpenQuote: String

This token is an open quote.

let NSLinguisticTagOrganizationName: String

This token is an organization name.

let NSLinguisticTagOther: String

The token indicates a token other than those currently defined.

let NSLinguisticTagOtherPunctuation: String

This token is punctuation not recognized as another token type.

let NSLinguisticTagOtherWhitespace: String

This token is whitespace.

let NSLinguisticTagOtherWord: String

This token is some other word.

let NSLinguisticTagParagraphBreak: String

This token is a paragraph break.

let NSLinguisticTagParticle: String

This token is a particle.

let NSLinguisticTagPersonalName: String

This token is a personal name.

let NSLinguisticTagPlaceName: String

This token is a place name.

let NSLinguisticTagPreposition: String

This token is a preposition.

let NSLinguisticTagPronoun: String

This token is a pronoun.

let NSLinguisticTagPunctuation: String

The token indicates punctuation.

let NSLinguisticTagSchemeLanguage: String

This tag scheme tags tokens according to their script. The tag values will be standard language abbreviations such as “en”, “fr”, “de”, etc., as used with the NSOrthography class. Note that the tagger generally attempts to determine the language of text at the level of an entire sentence or paragraph, rather than word by word.

let NSLinguisticTagSchemeLemma: String

This tag scheme supplies a stem forms of the words, if known.

let NSLinguisticTagSchemeLexicalClass: String

This tag scheme classifies tokens according to class: part of speech for words, type of punctuation or whitespace, etc. The value will be one of the constants specified in NSLinguisticTagSchemeLexicalClass. For this scheme a client may use pointer equality to compare the values with the tag constants.

let NSLinguisticTagSchemeNameType: String

This tag scheme classifies tokens as to whether they are part of named entities of various types or not. The possible tags are: NSLinguisticTagPersonalName, NSLinguisticTagPlaceName, or NSLinguisticTagOrganizationName. For this scheme a client may use pointer equality to compare the values with the tag constants.

let NSLinguisticTagSchemeNameTypeOrLexicalClass: String

This tag scheme follows NSLinguisticTagSchemeNameType for names, NSLinguisticTagSchemeLexicalClass for all other tokens. The possible tags are those specified in NSLinguisticTagSchemeLexicalClass or NSLinguisticTagSchemeNameType. For this scheme a client may use pointer equality to compare the values with the tag constants.

let NSLinguisticTagSchemeScript: String

This tag scheme tags tokens according to their script. The tag values will be standard script abbreviations such as “Latn”, “Cyrl”, “Jpan”, “Hans”, “Hant”, etc.

let NSLinguisticTagSchemeTokenType: String

This tag scheme classifies tokens according to their broad type: word, punctuation, whitespace, etc. The possible tags are: NSLinguisticTagWord, NSLinguisticTagPunctuation, NSLinguisticTagWhitespace, or NSLinguisticTagOther. For this scheme a client may use pointer equality to compare the values with the tag constants.

let NSLinguisticTagSentenceTerminator: String

This token is a sentence terminator.

let NSLinguisticTagVerb: String

This token is a verb.

let NSLinguisticTagWhitespace: String

The token indicates white space of any sort.

let NSLinguisticTagWord: String

The token indicates a word.

let NSLinguisticTagWordJoiner: String

This token is a word joiner.

let NSLoadedClasses: String

An NSArray object containing the names (as NSString objects) of each class that was loaded

let NSMachErrorDomain: String

Mach errors

let NSMetadataQueryAccessibleUbiquitousExternalDocumentsScope: String

Search for documents outside the app’s container. This search can locate iCloud documents that the user previously opened using a document picker view controller. This lets your app access the documents again without requiring direct user interaction. The result’s NSMetadataItemURLKey attributes return security-scoped NSURLs. For more information on working with security-scoped URLs, see Security-Scoped URLs in NSURL.

let NSMetadataQueryIndexedLocalComputerScope: String

Search all indexed local mounted volumes including the current user’s home directory (even if the home directory is remote).

let NSMetadataQueryIndexedNetworkScope: String

Search all indexed user-mounted remote volumes.

let NSMetadataQueryLocalComputerScope: String

Search all local mounted volumes, including the user home directory. The user’s home directory is searched even if it is a remote volume.

let NSMetadataQueryNetworkScope: String

Search all user-mounted remote volumes.

let NSMetadataQueryResultContentRelevanceAttribute: String

let NSMetadataQueryUbiquitousDataScope: String

Search all files not in the Documents directories of the app’s iCloud container directories.

let NSMetadataQueryUbiquitousDocumentsScope: String

Search all files in the Documents directories of the app’s iCloud container directories.

let NSMetadataQueryUpdateAddedItemsKey: String

The key for retrieving an array of items added to the query result. By default, this array contains NSMetadataItem objects, representing the query’s results; however, the query’s delegate can substitute these objects with instances of a different class.

let NSMetadataQueryUpdateChangedItemsKey: String

The key for retrieving an array of items that have changed in the query result. By default, this array contains NSMetadataItem objects, representing the query’s results; however, the query’s delegate can substitute these objects with instances of a different class.

let NSMetadataQueryUpdateRemovedItemsKey: String

The key for retrieving an array of items removed from the query result. By default, this array contains NSMetadataItem objects, representing the query’s results; however, the query’s delegate can substitute these objects with instances of a different class.

let NSMetadataQueryUserHomeScope: String

Search the user’s home directory.

let NSMetadataUbiquitousItemContainerDisplayNameKey: Stringlet NSMetadataUbiquitousItemDownloadRequestedKey: Stringlet NSMetadataUbiquitousItemDownloadingErrorKey: Stringlet NSMetadataUbiquitousItemDownloadingStatusCurrent: Stringlet NSMetadataUbiquitousItemDownloadingStatusDownloaded: Stringlet NSMetadataUbiquitousItemDownloadingStatusKey: Stringlet NSMetadataUbiquitousItemDownloadingStatusNotDownloaded: Stringlet NSMetadataUbiquitousItemHasUnresolvedConflictsKey: String

let NSMetadataUbiquitousItemIsDownloadedKey: StringDeprecated

let NSOSStatusErrorDomain: String

Mac OS 9/Carbon errors

let NSPOSIXErrorDomain: String

POSIX/BSD errors

let NSPersianCalendar: String

Identifier for the Persian calendar.

Deprecated

let NSPersonNameComponentDelimiter: Stringlet NSPersonNameComponentFamilyName: Stringlet NSPersonNameComponentGivenName: Stringlet NSPersonNameComponentKey: Stringlet NSPersonNameComponentMiddleName: Stringlet NSPersonNameComponentNickname: Stringlet NSPersonNameComponentPrefix: Stringlet NSPersonNameComponentSuffix: String

let NSRepublicOfChinaCalendar: String

Identifier for the Republic of China (Taiwan) calendar.

Deprecated

let NSStreamSOCKSErrorDomain: String

The error domain used by NSError when reporting SOCKS errors.

let NSStreamSocketSSLErrorDomain: String

The error domain used by NSError when reporting SSL errors.

let NSTextCheckingAirlineKey: String

A key that corresponds to the airline of a transit result.

let NSTextCheckingCityKey: String

A key that corresponds to the city component of the address.

let NSTextCheckingCountryKey: String

A key that corresponds to the country component of the address.

let NSTextCheckingFlightKey: String

A key that corresponds to the flight component of a transit result.

let NSTextCheckingJobTitleKey: String

A key that corresponds to the job component of the address.

let NSTextCheckingNameKey: String

A key that corresponds to the name component of the address.

let NSTextCheckingOrganizationKey: String

A key that corresponds to the organization component of the address.

let NSTextCheckingPhoneKey: String

A key that corresponds to the phone number component of the address.

let NSTextCheckingStateKey: String

A key that corresponds to the state or province component of the address.

let NSTextCheckingStreetKey: String

A key that corresponds to the street address component of the address.

let NSTextCheckingZIPKey: String

A key that corresponds to the zip code or postal code component of the address.

var NSTimeIntervalSince1970: Double

The number of seconds from 1 January 1970 to the reference date, 1 January 2001.

let NSURLAuthenticationMethodClientCertificate: String

Use client certificate authentication for this protection space.

let NSURLAuthenticationMethodDefault: String

Use the default authentication method for a protocol.

let NSURLAuthenticationMethodHTMLForm: String

Use HTML form authentication for this protection space.

let NSURLAuthenticationMethodHTTPBasic: String

Use HTTP basic authentication for this protection space.

let NSURLAuthenticationMethodHTTPDigest: String

Use HTTP digest authentication for this protection space.

let NSURLAuthenticationMethodNTLM: String

Use NTLM authentication for this protection space.

let NSURLAuthenticationMethodNegotiate: String

Negotiate whether to use Kerberos or NTLM authentication for this protection space.

let NSURLAuthenticationMethodServerTrust: String

Perform server trust authentication (certificate validation) for this protection space.

let NSURLCredentialStorageRemoveSynchronizableCredentials: String

The corresponding value is an NSNumber object representing a Boolean value that indicates whether credentials which contain the synchronizable attribute should be removed.

let NSURLErrorBackgroundTaskCancelledReasonKey: String

An NSNumber value indicating why a background task was cancelled. For a list of possible values, see NSURLSession-Specific NSError userInfo Dictionary Keys.

let NSURLErrorFailingURLErrorKey: String

The corresponding value is an NSURL containing the URL which caused a load to fail. This key is only present in the NSURLErrorDomain.

let NSURLErrorFailingURLPeerTrustErrorKey: String

The corresponding value is the SecTrust object representing the state of a failed SSL handshake. This key is only present in the NSURLErrorDomain.

let NSURLErrorFailingURLStringErrorKey: String

The corresponding value is an NSString object for the URL which caused a load to fail. This key is only present in the NSURLErrorDomain.

let NSURLErrorKey: String

The corresponding value is an NSURL object.

let NSURLFileScheme: String

Identifies a URL that points to a file on a mounted volume.

let NSURLProtectionSpaceFTP: String

The protocol type for FTP.

let NSURLProtectionSpaceFTPProxy: String

The proxy type for FTP proxies.

let NSURLProtectionSpaceHTTP: String

The protocol type for HTTP.

let NSURLProtectionSpaceHTTPProxy: String

The proxy type for HTTP proxies.

let NSURLProtectionSpaceHTTPS: String

The protocol type for HTTPS.

let NSURLProtectionSpaceHTTPSProxy: String

The proxy type for HTTPS proxies.

let NSURLProtectionSpaceSOCKSProxy: String

The proxy type for SOCKS proxies.

let NSURLSessionDownloadTaskResumeData: String

A key in the error dictionary that provides resume data.

let NSURLSessionTransferSizeUnknown: Int64

The total size of the transfer cannot be determined.

let NSUbiquitousKeyValueStoreChangeReasonKey: Stringlet NSUbiquitousKeyValueStoreChangedKeysKey: Stringlet NSUndoCloseGroupingRunLoopOrdering: Intlet NSUndoManagerGroupIsDiscardableKey: Stringlet NSUserActivityTypeBrowsingWeb: String

let NSUserNotificationDefaultSoundName: String

The default notification sound.

let NSFileManagerUnmountDissentingProcessIdentifierErrorKey: String

let NSFilePathErrorKey: String

Contains the file path of the error.

let NSHelpAnchorErrorKey: String

The corresponding value is an NSString containing the localized help corresponding to the help button. See helpAnchor for more information.

var kCFStringEncodingASCII: CFStringEncoding

let NSLocalizedDescriptionKey: String

The corresponding value is a localized string representation of the error that, if present, will be returned by localizedDescription.

let NSLocalizedFailureReasonErrorKey: String

The corresponding value is a localized string representation containing the reason for the failure that, if present, will be returned by localizedFailureReason.

let NSLocalizedRecoveryOptionsErrorKey: String

The corresponding value is an array containing the localized titles of buttons appropriate for displaying in an alert panel.

let NSLocalizedRecoverySuggestionErrorKey: String

The corresponding value is a string containing the localized recovery suggestion for the error.

let NSRecoveryAttempterErrorKey: String

The corresponding value is an object that conforms to the NSErrorRecoveryAttempting informal protocol.

let NSStringEncodingErrorKey: String

The corresponding value is an NSNumber object containing the NSStringEncoding value.

let NSUnderlyingErrorKey: String

The corresponding value is an error that was encountered in an underlying implementation and caused the error that the receiver represents to occur.