Foundation Constants Reference

Framework	Foundation/Foundation.h
Declared in	FoundationErrors.h NSByteOrder.h NSDecimal.h NSError.h NSException.h NSGeometry.h NSHashTable.h NSJavaSetup.h NSMapTable.h NSObjCRuntime.h NSPathUtilities.h NSURLError.h NSZone.h

Overview

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

Constants

Enumerations

NSByteOrder

Specifies an byte-order format.

enum _NSByteOrder {
   NS_UnknownByteOrder = CFByteOrderUnknown,
   NS_LittleEndian = CFByteOrderLittleEndian,
   NS_BigEndian = CFByteOrderBigEndian
};

Constants

NS_UnknownByteOrder

The byte order is unknown.

Available in OS X v10.0 and later.

Declared in NSByteOrder.h.

NS_LittleEndian

The byte order is little endian.

Available in OS X v10.0 and later.

Declared in NSByteOrder.h.

NS_BigEndian

The byte order is big endian.

Available in OS X v10.0 and later.

Declared in NSByteOrder.h.

Discussion

These constants are returned by NSHostByteOrder.

NSNotFound

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

enum {
   NSNotFound = NSIntegerMax
};

Constants

NSNotFound

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

Available in OS X v10.0 and later.

Declared in NSObjCRuntime.h.

Discussion

NSNotFound is typically used by various methods and functions that search for items in serial data and return indices, such as characters in a string object or ids in an NSArray object.

Special Considerations

Prior to OS X v10.5, NSNotFound was defined as 0x7fffffff. For 32-bit systems, this was effectively the same as NSIntegerMax. To support 64-bit environments, NSNotFound is now formally defined as NSIntegerMax. This means, however, that the value is different in 32-bit and 64-bit environments. You should therefore not save the value directly in files or archives. Moreover, sending the value between 32-bit and 64-bit processes via Distributed Objects will not get you NSNotFound on the other side. This applies to any Cocoa methods invoked over Distributed Objects and which might return NSNotFound, such as the indexOfObject: method of NSArray (if sent to a proxy for an array).

Memory Allocation

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

enum {
   NSScannedOption = (1<<0),
   NSCollectorDisabledOption = (2<<0),
};

Constants

NSScannedOption

Specifies allocation of scanned memory.

Available in OS X v10.4 and later.

Declared in NSZone.h.

NSCollectorDisabledOption

Specifies that the block is retained, and therefore ineligible for collection. Specifying this option is equivalent to invoking disableCollectorForPointer: with the returned block as the argument.

Available in OS X v10.5 and later.

Declared in NSZone.h.

Declared In

NSGarbageCollector.h

NSEnumerationOptions

Options for Block enumeration operations.

enum {
   NSEnumerationConcurrent = (1UL << 0),
   NSEnumerationReverse = (1UL << 1),
};
typedef NSUInteger NSEnumerationOptions;

Constants

NSEnumerationConcurrent

Specifies that the Block enumeration should be concurrent.

The order of invocation is nondeterministic and undefined; this flag is a hint and may be ignored by the implementation under some circumstances; the code of the Block must be safe against concurrent invocation.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSEnumerationReverse

Specifies that the enumeration should be performed in reverse.

This option is available for NSArray and NSIndexSet classes; its behavior is undefined for NSDictionary and NSSet classes, or when combined with the NSEnumerationConcurrent flag.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

Declared In

NSObjCRuntime.h

NSComparisonResult

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

enum {
   NSOrderedAscending = -1,
   NSOrderedSame,
   NSOrderedDescending
};
typedef NSInteger NSComparisonResult;

Constants

NSOrderedAscending

The left operand is smaller than the right operand.

Available in OS X v10.0 and later.

Declared in NSObjCRuntime.h.

NSOrderedSame

The two operands are equal.

Available in OS X v10.0 and later.

Declared in NSObjCRuntime.h.

NSOrderedDescending

The left operand is greater than the right operand.

Available in OS X v10.0 and later.

Declared in NSObjCRuntime.h.

Discussion

These constants are used to indicate how items in a request are ordered, from the first one given in a method invocation or function call to the last (that is, left to right in code).

NSSortOptions

Options for Block sorting operations.

enum {
   NSSortConcurrent = (1UL << 0),
   NSSortStable = (1UL << 4),
};
typedef NSUInteger NSSortOptions;

Constants

NSSortConcurrent

Specifies that the Block sort operation should be concurrent.

This option is a hint and may be ignored by the implementation under some circumstances; the code of the Block must be safe against concurrent invocation.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSSortStable

Specifies that the sorted results should return compared items have equal value in the order they occurred originally.

If this option is unspecified equal objects may, or may not, be returned in their original order.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

Declared In

NSObjCRuntime.h

NSSearchPathDirectory

These constants specify the location of a variety of directories by the URLsForDirectory:inDomains: and URLForDirectory:inDomain:appropriateForURL:create:error: NSFileManager methods.

enum {
   NSApplicationDirectory = 1,
   NSDemoApplicationDirectory,
   NSDeveloperApplicationDirectory,
   NSAdminApplicationDirectory,
   NSLibraryDirectory,
   NSDeveloperDirectory,
   NSUserDirectory,
   NSDocumentationDirectory,
   NSDocumentDirectory,
   NSCoreServiceDirectory,
   NSAutosavedInformationDirectory = 11,
   NSDesktopDirectory = 12,
   NSCachesDirectory = 13,
   NSApplicationSupportDirectory = 14,
   NSDownloadsDirectory = 15,
   NSInputMethodsDirectory = 16,
   NSMoviesDirectory = 17,
   NSMusicDirectory = 18,
   NSPicturesDirectory = 19,
   NSPrinterDescriptionDirectory = 20,
   NSSharedPublicDirectory = 21,
   NSPreferencePanesDirectory = 22,
   NSApplicationScriptsDirectory = 23,
   NSItemReplacementDirectory = 99,
   NSAllApplicationsDirectory = 100,
   NSAllLibrariesDirectory = 101,
   NSTrashDirectory = 102
};
typedef NSUInteger NSSearchPathDirectory;

Constants

NSApplicationDirectory

Supported applications (/Applications).

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSDemoApplicationDirectory

Unsupported applications and demonstration versions.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSDeveloperApplicationDirectory

Developer applications (/Developer/Applications).

Deprecated: As of Xcode 4.3, there is no longer a Developer Application directory directory; instead, Xcode.app is a self-contained application that gets installed in the user’s Applications directory, by default, although it can be put anywhere.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSAdminApplicationDirectory

System and network administration applications.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSLibraryDirectory

Various user-visible documentation, support, and configuration files (/Library).

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSDeveloperDirectory

Developer resources (/Developer).

Deprecated: As of Xcode 4.3, there is no longer a Developer directory; instead, Xcode.app is a self-contained application that gets installed in the user’s Applications directory, by default, although it can be put anywhere.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSUserDirectory

User home directories (/Users).

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSDocumentationDirectory

Documentation.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSDocumentDirectory

Document directory.

Available in OS X v10.2 and later.

Declared in NSPathUtilities.h.

NSCoreServiceDirectory

Location of core services (System/Library/CoreServices).

Available in OS X v10.4 and later.

Declared in NSPathUtilities.h.

NSAutosavedInformationDirectory

Location of user’s autosaved documents Library/Autosave Information

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSDesktopDirectory

Location of user’s desktop directory.

Available in OS X v10.4 and later.

Declared in NSPathUtilities.h.

NSCachesDirectory

Location of discardable cache files (Library/Caches).

Available in OS X v10.4 and later.

Declared in NSPathUtilities.h.

NSApplicationSupportDirectory

Location of application support files (Library/Application Support).

Available in OS X v10.4 and later.

Declared in NSPathUtilities.h.

NSDownloadsDirectory

Location of the user’s downloads directory.

The NSDownloadsDirectory flag will only produce a path only when the NSUserDomainMask is provided.

Available in OS X v10.5 and later.

Declared in NSPathUtilities.h.

NSInputMethodsDirectory

Location of Input Methods (Library/Input Methods)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSMoviesDirectory

Location of user's Movies directory (~/Movies)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSMusicDirectory

Location of user's Music directory (~/Music)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSPicturesDirectory

Location of user's Pictures directory (~/Pictures)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSPrinterDescriptionDirectory

Location of system's PPDs directory (Library/Printers/PPDs)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSSharedPublicDirectory

Location of user's Public sharing directory (~/Public)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSPreferencePanesDirectory

Location of the PreferencePanes directory for use with System Preferences (Library/PreferencePanes)

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSApplicationScriptsDirectory

Location of the user scripts folder for the calling application (~/Library/Application Scripts/<code-signing-id>

Available in OS X v10.8 and later.

Declared in NSPathUtilities.h.

NSItemReplacementDirectory

For use with NSFileManager method URLForDirectory:inDomain:appropriateForURL:create:error:

Available in OS X v10.6 and later.

Declared in NSPathUtilities.h.

NSAllApplicationsDirectory

All directories where applications can occur.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSAllLibrariesDirectory

All directories where resources can occur.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSTrashDirectory

Location of the trash directory.

Available in OS X v10.8 and later.

Declared in NSPathUtilities.h.

NSSearchPathDomainMask

Search path domain constants specifying base locations for the NSSearchPathDirectory type. These constants are used by the URLsForDirectory:inDomains: and URLForDirectory:inDomain:appropriateForURL:create:error: NSFileManager methods.

enum {
   NSUserDomainMask = 1,
   NSLocalDomainMask = 2,
   NSNetworkDomainMask = 4,
   NSSystemDomainMask = 8,
   NSAllDomainsMask = 0x0ffff,
};
typedef NSUInteger NSSearchPathDomainMask;

Constants

NSUserDomainMask

The user’s home directory—the place to install user’s personal items (~).

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSLocalDomainMask

Local to the current machine—the place to install items available to everyone on this machine.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSNetworkDomainMask

Publicly available location in the local area network—the place to install items available on the network (/Network).

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSSystemDomainMask

Provided by Apple—can’t be modified (/System) .

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

NSAllDomainsMask

All domains.

Includes all of the above and future items.

Available in OS X v10.0 and later.

Declared in NSPathUtilities.h.

Declared In

NSPathUtilities.h

NSError Codes

NSError codes in the Cocoa error domain.

enum {
   NSFileNoSuchFileError = 4,
   NSFileLockingError = 255,
   NSFileReadUnknownError = 256,
   NSFileReadNoPermissionError = 257,
   NSFileReadInvalidFileNameError = 258,
   NSFileReadCorruptFileError = 259,
   NSFileReadNoSuchFileError = 260,
   NSFileReadInapplicableStringEncodingError = 261,
   NSFileReadUnsupportedSchemeError = 262,
   NSFileReadTooLargeError = 263,
   NSFileReadUnknownStringEncodingError = 264,
   NSFileWriteUnknownError = 512,
   NSFileWriteNoPermissionError = 513,
   NSFileWriteInvalidFileNameError = 514,
   NSFileWriteFileExistsError = 516,
   NSFileWriteInapplicableStringEncodingError = 517,
   NSFileWriteUnsupportedSchemeError = 518,
   NSFileWriteOutOfSpaceError = 640,
   NSFileWriteVolumeReadOnlyError = 642,
   NSKeyValueValidationError = 1024,
   NSFormattingError = 2048,
   NSUserCancelledError = 3072,
   
   NSFileErrorMinimum = 0,
   NSFileErrorMaximum = 1023,
   NSValidationErrorMinimum = 1024,
   NSValidationErrorMaximum = 2047,
   NSFormattingErrorMinimum = 2048,
   NSFormattingErrorMaximum = 2559,
   
   NSPropertyListReadCorruptError = 3840,
   NSPropertyListReadUnknownVersionError = 3841,
   NSPropertyListReadStreamError = 3842,
   NSPropertyListWriteStreamError = 3851,
   NSPropertyListErrorMinimum = 3840,
   NSPropertyListErrorMaximum = 4095
   
   NSExecutableErrorMinimum = 3584,
   NSExecutableNotLoadableError = 3584,
   NSExecutableArchitectureMismatchError = 3585,
   NSExecutableRuntimeMismatchError = 3586,
   NSExecutableLoadError = 3587,
   NSExecutableLinkError = 3588,
   NSExecutableErrorMaximum = 3839,
   
}

Constants

NSFileNoSuchFileError

File-system operation attempted on non-existent file

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileLockingError

Failure to get a lock on file

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadUnknownError

Read error, reason unknown

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadNoPermissionError

Read error because of a permission problem

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadInvalidFileNameError

Read error because of an invalid file name

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadCorruptFileError

Read error because of a corrupted file, bad format, or similar reason

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadNoSuchFileError

Read error because no such file was found

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadInapplicableStringEncodingError

Read error because the string encoding was not applicable.

Access the bad encoding from the userInfo dictionary using the NSStringEncodingErrorKey key.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadUnsupportedSchemeError

Read error because the specified URL scheme is unsupported

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileReadTooLargeError

Read error because the specified file was too large.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSFileReadUnknownStringEncodingError

Read error because the string coding of the file could not be determined

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSFileWriteUnknownError

Write error, reason unknown

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileWriteNoPermissionError

Write error because of a permission problem

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileWriteInvalidFileNameError

Write error because of an invalid file name

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileWriteFileExistsError

Write error returned when NSFileManager class’s copy, move, and link methods report errors when the destination file already exists.

Available in OS X v10.7 and later.

Declared in FoundationErrors.h.

NSFileWriteInapplicableStringEncodingError

Write error because the string encoding was not applicable.

Access the bad encoding from the userInfo dictionary using the NSStringEncodingErrorKey key.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileWriteUnsupportedSchemeError

Write error because the specified URL scheme is unsupported

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileWriteOutOfSpaceError

Write error because of a lack of disk space

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileWriteVolumeReadOnlyError

Write error because because the volume is read only.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSKeyValueValidationError

Key-value coding validation error

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFormattingError

Formatting error (related to display of data)

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSUserCancelledError

The user cancelled the operation (for example, by pressing Command-period).

This code is for errors that do not require a dialog displayed and might be candidates for special-casing.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileErrorMinimum

Marks the start of the range of error codes reserved for file errors

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFileErrorMaximum

Marks the end of the range of error codes reserved for file errors

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSValidationErrorMinimum

Marks the start of the range of error codes reserved for validation errors.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSValidationErrorMaximum

Marks the start and end of the range of error codes reserved for validation errors.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFormattingErrorMinimum

Marks the start of the range of error codes reserved for formatting errors.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSFormattingErrorMaximum

Marks end of the range of error codes reserved for formatting errors.

Available in OS X v10.4 and later.

Declared in FoundationErrors.h.

NSPropertyListReadCorruptError

An error was encountered while parsing the property list.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSPropertyListReadUnknownVersionError

The version number of the property list is unable to be determined.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSPropertyListReadStreamError

An stream error was encountered while reading the property list.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSPropertyListWriteStreamError

An stream error was encountered while writing the property list.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSPropertyListErrorMinimum

Marks beginning of the range of error codes reserved for property list errors.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSPropertyListErrorMaximum

Marks end of the range of error codes reserved for property list errors.

Available in OS X v10.6 and later.

Declared in FoundationErrors.h.

NSExecutableErrorMinimum

Marks beginning of the range of error codes reserved for errors related to executable files.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSExecutableNotLoadableError

Executable is of a type that is not loadable in the current process.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSExecutableArchitectureMismatchError

Executable does not provide an architecture compatible with the current process.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSExecutableRuntimeMismatchError

Executable has Objective C runtime information incompatible with the current process.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSExecutableLoadError

Executable cannot be loaded for some other reason, such as a problem with a library it depends on.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSExecutableLinkError

Executable fails due to linking issues.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

NSExecutableErrorMaximum

Marks end of the range of error codes reserved for errors related to executable files.

Available in OS X v10.5 and later.

Declared in FoundationErrors.h.

Discussion

The constants in this enumeration are NSError code numbers in the Cocoa error domain (NSCocoaErrorDomain). Other frameworks, most notably the Application Kit, provide their own NSCocoaErrorDomain error codes.

The enumeration constants beginning with NSFile indicate file-system errors or errors related to file I/O operations. Use the key NSFilePathErrorKey or the NSURLErrorKey (whichever is appropriate) to access the file-system path or URL in the userInfo dictionary of the NSError object.

Declared In

FoundationErrors.h

URL Loading System Error Codes

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

enum
{
   NSURLErrorUnknown = -1,
   NSURLErrorCancelled = -999,
   NSURLErrorBadURL = -1000,
   NSURLErrorTimedOut = -1001,
   NSURLErrorUnsupportedURL = -1002,
   NSURLErrorCannotFindHost = -1003,
   NSURLErrorCannotConnectToHost = -1004,
   NSURLErrorDataLengthExceedsMaximum = -1103,
   NSURLErrorNetworkConnectionLost = -1005,
   NSURLErrorDNSLookupFailed = -1006,
   NSURLErrorHTTPTooManyRedirects = -1007,
   NSURLErrorResourceUnavailable = -1008,
   NSURLErrorNotConnectedToInternet = -1009,
   NSURLErrorRedirectToNonExistentLocation = -1010,
   NSURLErrorBadServerResponse = -1011,
   NSURLErrorUserCancelledAuthentication = -1012,
   NSURLErrorUserAuthenticationRequired = -1013,
   NSURLErrorZeroByteResource = -1014,
   NSURLErrorCannotDecodeRawData = -1015,
   NSURLErrorCannotDecodeContentData = -1016,
   NSURLErrorCannotParseResponse = -1017,
   NSURLErrorInternationalRoamingOff = -1018,
   NSURLErrorCallIsActive = -1019,
   NSURLErrorDataNotAllowed = -1020,
   NSURLErrorRequestBodyStreamExhausted = -1021,
   NSURLErrorFileDoesNotExist = -1100,
   NSURLErrorFileIsDirectory = -1101,
   NSURLErrorNoPermissionsToReadFile = -1102,
   NSURLErrorSecureConnectionFailed = -1200,
   NSURLErrorServerCertificateHasBadDate = -1201,
   NSURLErrorServerCertificateUntrusted = -1202,
   NSURLErrorServerCertificateHasUnknownRoot = -1203,
   NSURLErrorServerCertificateNotYetValid = -1204,
   NSURLErrorClientCertificateRejected = -1205,
   NSURLErrorClientCertificateRequired = -1206,
   NSURLErrorCannotLoadFromNetwork = -2000,
   NSURLErrorCannotCreateFile = -3000,
   NSURLErrorCannotOpenFile = -3001,
   NSURLErrorCannotCloseFile = -3002,
   NSURLErrorCannotWriteToFile = -3003,
   NSURLErrorCannotRemoveFile = -3004,
   NSURLErrorCannotMoveFile = -3005,
   NSURLErrorDownloadDecodingFailedMidStream = -3006,
   NSURLErrorDownloadDecodingFailedToComplete = -3007
}

Constants

NSURLErrorUnknown

Returned when the URL Loading system encounters an error that it cannot interpret.

This can occur when an error originates from a lower level framework or library. Whenever this error code is received, it is a bug, and should be reported to Apple.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCancelled

Returned when an asynchronous load is canceled.

A Web Kit framework delegate will receive this error when it performs a cancel operation on a loading resource. Note that an NSURLConnection or NSURLDownload delegate will not receive this error if the download is canceled.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorBadURL

Returned when a URL is sufficiently malformed that a URL request cannot be initiated

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorTimedOut

Returned when an asynchronous operation times out.

NSURLConnection will send this error to its delegate when the timeoutInterval in NSURLRequest expires before a load can complete.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorUnsupportedURL

Returned when a properly formed URL cannot be handled by the framework.

The most likely cause is that there is no available protocol handler for the URL.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotFindHost

Returned when the host name for a URL cannot be resolved.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotConnectToHost

Returned when an attempt to connect to a host has failed.

This can occur when a host name resolves, but the host is down or may not be accepting connections on a certain port.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorDataLengthExceedsMaximum

Returned when the length of the resource data exceeds the maximum allowed.

Available in OS X v10.5 and later.

Declared in NSURLError.h.

NSURLErrorNetworkConnectionLost

Returned when a client or server connection is severed in the middle of an in-progress load.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorDNSLookupFailed

See NSURLErrorCannotFindHost

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorHTTPTooManyRedirects

Returned when a redirect loop is detected or when the threshold for number of allowable redirects has been exceeded (currently 16).

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorResourceUnavailable

Returned when a requested resource cannot be retrieved.

Examples are “file not found”, and data decoding problems that prevent data from being processed correctly.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorNotConnectedToInternet

Returned when a network resource was requested, but an internet connection is not established and cannot be established automatically, either through a lack of connectivity, or by the user's choice not to make a network connection automatically.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorRedirectToNonExistentLocation

Returned when a redirect is specified by way of server response code, but the server does not accompany this code with a redirect URL.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorBadServerResponse

Returned when the URL Loading system receives bad data from the server.

This is equivalent to the “500 Server Error” message sent by HTTP servers.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorUserCancelledAuthentication

Returned when an asynchronous request for authentication is cancelled by the user.

This is typically incurred by clicking a “Cancel” button in a username/password dialog, rather than the user making an attempt to authenticate.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorUserAuthenticationRequired

Returned when authentication is required to access a resource.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorZeroByteResource

Returned when a server reports that a URL has a non-zero content length, but terminates the network connection “gracefully” without sending any data.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotDecodeRawData

Returned when content data received during an NSURLConnection request cannot be decoded for a known content encoding.

Available in OS X v10.5 and later.

Declared in NSURLError.h.

NSURLErrorCannotDecodeContentData

Returned when content data received during an NSURLConnection request has an unknown content encoding.

Available in OS X v10.5 and later.

Declared in NSURLError.h.

NSURLErrorCannotParseResponse

Returned when a response to an NSURLConnection request cannot be parsed.

Available in OS X v10.5 and later.

Declared in NSURLError.h.

NSURLErrorInternationalRoamingOff

Returned when a connection would require activating a data context while roaming, but international roaming is disabled.

Available in OS X v10.7 and later.

Declared in NSURLError.h.

NSURLErrorCallIsActive

Returned when a connection is attempted while a phone call is active on a network that does not support simultaneous phone and data communication (EDGE or GPRS).

Available in OS X v10.7 and later.

Declared in NSURLError.h.

NSURLErrorDataNotAllowed

Returned when the cellular network disallows a connection.

Available in OS X v10.7 and later.

Declared in NSURLError.h.

NSURLErrorRequestBodyStreamExhausted

Returned when a body stream is needed but the client does not provide one. This impacts clients on iOS that send a POST request using a body stream but do not implement the NSURLConnection delegate method connection:needNewBodyStream.

Available in OS X v10.7 and later.

Declared in NSURLError.h.

NSURLErrorFileDoesNotExist

Returned when a file does not exist.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorFileIsDirectory

Returned when a request for an FTP file results in the server responding that the file is not a plain file, but a directory.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorNoPermissionsToReadFile

Returned when a resource cannot be read due to insufficient permissions.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorSecureConnectionFailed

Returned when an attempt to establish a secure connection fails for reasons which cannot be expressed more specifically.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorServerCertificateHasBadDate

Returned when a server certificate has a date which indicates it has expired, or is not yet valid.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorServerCertificateUntrusted

Returned when a server certificate is signed by a root server which is not trusted.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorServerCertificateHasUnknownRoot

Returned when a server certificate is not signed by any root server.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorServerCertificateNotYetValid

Returned when a server certificate is not yet valid.

Available in OS X v10.4 and later.

Declared in NSURLError.h.

NSURLErrorClientCertificateRejected

Returned when a server certificate is rejected.

Available in OS X v10.4 and later.

Declared in NSURLError.h.

NSURLErrorClientCertificateRequired

Returned when a client certificate is required to authenticate an SSL connection during an NSURLConnection request.

Available in OS X v10.6 and later.

Declared in NSURLError.h.

NSURLErrorCannotLoadFromNetwork

Returned when a specific request to load an item only from the cache cannot be satisfied.

This error is sent at the point when the library would go to the network accept for the fact that is has been blocked from doing so by the “load only from cache” directive.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotCreateFile

Returned when NSURLDownload object was unable to create the downloaded file on disk due to a I/O failure.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotOpenFile

Returned when NSURLDownload was unable to open the downloaded file on disk.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotCloseFile

Returned when NSURLDownload was unable to close the downloaded file on disk.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotWriteToFile

Returned when NSURLDownload was unable to write to the downloaded file on disk.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotRemoveFile

Returned when NSURLDownload was unable to remove a downloaded file from disk.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorCannotMoveFile

Returned when NSURLDownload was unable to move a downloaded file on disk.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorDownloadDecodingFailedMidStream

Returned when NSURLDownload failed to decode an encoded file during the download.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

NSURLErrorDownloadDecodingFailedToComplete

Returned when NSURLDownload failed to decode an encoded file after downloading.

Available in OS X v10.2 and later.

Declared in NSURLError.h.

Availability

Available in OS X v10.2 with Safari 1.0 installed.
Available in OS X v10.2.7 and later.

Declared In

NSURLError.h

XPC Errors

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

   NSXPCConnectionInterrupted = 4097,    NSXPCConnectionInvalid = 4099,
   NSXPCConnectionReplyInvalid = 4101,    NSXPCConnectionErrorMinimum = 4096,
   NSXPCConnectionErrorMaximum = 4224

Constants

NSXPCConnectionInterrupted: The XPC connection was interrupted.
NSXPCConnectionInvalid: The XPC connection was invalid.
NSXPCConnectionReplyInvalid: The XPC connection replay was invalid.
NSXPCConnectionErrorMinimum: The XPC connection minimum error.
NSXPCConnectionErrorMaximum: The XPC connection maximum error.

Global Variables

Cocoa Error Domain

These constants defines the Cocoa error domain.

NSString *const NSCocoaErrorDomain;
NSString *const NSFeatureUnsupportedError;

Constants

NSCocoaErrorDomain

Application Kit and Foundation Kit errors.

Available in OS X v10.4 and later.

Declared in NSError.h.

NSFeatureUnsupportedError

NSFeatureUnsupportedError is a new error code in the NSCocoaErrorDomain that indicates a failure to perform the requested operation because the feature is not supported, either because the file system lacks the feature, or required libraries are missing, or other similar reasons.

For example, some volumes may not support a Trash folder, so these methods will report failure by returning NO or nil and an NSError with NSFeatureUnsupportedError.

Declared In

FoundationErrors.h

NSHashTable Callbacks

Predefined sets of callbacks for NSHashTable.

extern const NSHashTableCallBacks NSIntegerHashCallBacks;
extern const NSHashTableCallBacks NSIntHashCallBacks;
extern const NSHashTableCallBacks NSNonOwnedPointerHashCallBacks;
extern const NSHashTableCallBacks NSNonRetainedObjectHashCallBacks;
extern const NSHashTableCallBacks NSObjectHashCallBacks;
extern const NSHashTableCallBacks NSOwnedObjectIdentityHashCallBacks;
extern const NSHashTableCallBacks NSOwnedPointerHashCallBacks;
extern const NSHashTableCallBacks NSPointerToStructHashCallBacks;

Constants

NSIntegerHashCallBacks

For sets of NSInteger-sized quantities or smaller (for example, int, long, or unichar).

Available in OS X v10.5 and later.

Declared in NSHashTable.h.

NSIntHashCallBacks

For sets of pointer-sized quantities or smaller (for example, int, long, or unichar). (Deprecated. Use NSIntegerHashCallBacks instead.)

Available in OS X v10.0 and later.

Deprecated in OS X v10.5.

Declared in NSHashTable.h.

NSNonOwnedPointerHashCallBacks

For sets of pointers, hashed by address.

Available in OS X v10.0 and later.

Declared in NSHashTable.h.

NSNonRetainedObjectHashCallBacks

For sets of objects, but without retaining/releasing.

Available in OS X v10.0 and later.

Declared in NSHashTable.h.

NSObjectHashCallBacks

For sets of objects (similar to NSSet).

Available in OS X v10.0 and later.

Declared in NSHashTable.h.

NSOwnedObjectIdentityHashCallBacks

For sets of objects, with transfer of ownership upon insertion, using pointer equality.

Available in OS X v10.0 and later.

Declared in NSHashTable.h.

NSOwnedPointerHashCallBacks

For sets of pointers, with transfer of ownership upon insertion.

Available in OS X v10.0 and later.

Declared in NSHashTable.h.

NSPointerToStructHashCallBacks

For sets of pointers to structs, when the first field of the struct is int-sized.

Available in OS X v10.0 and later.

Declared in NSHashTable.h.

Discussion

On OS X v10.5 and later, see also the NSHashTable class.

Note that you can make your own callback by picking fields among the above callbacks.

Declared In

NSHashTable.h

NSMapTable Key Call Backs

Predefined sets of callbacks for NSMapTable keys.

extern const NSMapTableKeyCallBacks NSIntegerMapKeyCallBacks;
extern const NSMapTableKeyCallBacks NSIntMapKeyCallBacks;
extern const NSMapTableKeyCallBacks NSNonOwnedPointerMapKeyCallBacks;
extern const NSMapTableKeyCallBacks  NSNonOwnedPointerOrNullMapKeyCallBacks;
extern const NSMapTableKeyCallBacks NSNonRetainedObjectMapKeyCallBacks;
extern const NSMapTableKeyCallBacks NSObjectMapKeyCallBacks;
extern const NSMapTableKeyCallBacks NSOwnedPointerMapKeyCallBacks;

Constants

NSIntegerMapKeyCallBacks

For keys that are pointer-sized quantities or smaller (for example, int, long, or unichar).

Available in OS X v10.5 and later.

Declared in NSMapTable.h.

NSIntMapKeyCallBacks

For keys that are pointer-sized quantities or smaller (for example, int, long, or unichar). (Deprecated. Use NSIntegerMapKeyCallBacks instead.)

Available in OS X v10.0 and later.

Deprecated in OS X v10.5.

Declared in NSMapTable.h.

NSNonOwnedPointerMapKeyCallBacks

For keys that are pointers not freed.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSNonOwnedPointerOrNullMapKeyCallBacks

For keys that are pointers not freed, or NULL.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSNonRetainedObjectMapKeyCallBacks

For sets of objects, but without retaining/releasing.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSObjectMapKeyCallBacks

For keys that are objects.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSOwnedPointerMapKeyCallBacks

For keys that are pointers, with transfer of ownership upon insertion.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

Discussion

On OS X v10.5 and later, see also the NSMapTable class.

Note that you can make your own callback by picking fields among the above callbacks.

Declared In

NSMapTable.h

NSMapTable Value Callbacks

These are predefined sets of callbacks for NSMapTable values.

extern const NSMapTableValueCallBacks NSIntegerMapValueCallBacks;
extern const NSMapTableValueCallBacks NSIntMapValueCallBacks;
extern const NSMapTableValueCallBacks NSNonOwnedPointerMapValueCallBacks;
extern const NSMapTableValueCallBacks NSObjectMapValueCallBacks;
extern const NSMapTableValueCallBacks NSNonRetainedObjectMapValueCallBacks;
extern const NSMapTableValueCallBacks NSOwnedPointerMapValueCallBacks;

Constants

NSIntegerMapValueCallBacks

For values that are pointer-sized quantities, (for example, int, long, or unichar).

Available in OS X v10.5 and later.

Declared in NSMapTable.h.

NSIntMapValueCallBacks

For values that are pointer-sized quantities, (for example, int, long, or unichar). (Deprecated. Use NSIntegerMapValueCallBacks instead.)

Available in OS X v10.0 and later.

Deprecated in OS X v10.5.

Declared in NSMapTable.h.

NSNonOwnedPointerMapValueCallBacks

For values that are not owned pointers.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSOwnedPointerMapValueCallBacks

For values that are owned pointers.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSNonRetainedObjectMapValueCallBacks

For sets of objects, but without retaining/releasing.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSObjectMapValueCallBacks

For values that are objects.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

Discussion

On OS X v10.5 and later, see also the NSMapTable class.

Note that you can make your own callback by picking fields among the above callbacks.

Declared In

NSMapTable.h

NSURL Domain

This error domain is defined for NSURL.

extern NSString * const NSURLErrorDomain;

Constants

NSURLErrorDomain

URL loading system errors

Available in OS X v10.2 and later.

Declared in NSURLError.h.

Declared In

NSURLError.h

Zero Constants

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

extern const NSPoint NSZeroPoint;
extern const NSSize NSZeroSize;
extern const NSRect NSZeroRect;

Constants

NSZeroPoint

An NSPoint structure with both x and y coordinates set to 0.

Available in OS X v10.0 and later.

Declared in NSGeometry.h.

NSZeroSize

An NSSize structure set to 0 in both dimensions.

Available in OS X v10.0 and later.

Declared in NSGeometry.h.

NSZeroRect

An NSRect structure set to 0 in width and height.

Available in OS X v10.0 and later.

Declared in NSGeometry.h.

Declared In

NSGeometry.h

Geometric Alignment

NSAlignmentOptions

These constants are used by the NSIntegralRectWithOptions function and the related methods.

enum {
   NSAlignMinXInward   = 1ULL << 0,
   NSAlignMinYInward   = 1ULL << 1,
   NSAlignMaxXInward   = 1ULL << 2,
   NSAlignMaxYInward   = 1ULL << 3,
   NSAlignWidthInward  = 1ULL << 4,
   NSAlignHeightInward = 1ULL << 5,
   NSAlignMinXOutward   = 1ULL << 8,
   NSAlignMinYOutward   = 1ULL << 9,
   NSAlignMaxXOutward   = 1ULL << 10,
   NSAlignMaxYOutward   = 1ULL << 11,
   NSAlignWidthOutward  = 1ULL << 12,
   NSAlignHeightOutward = 1ULL << 13,
   NSAlignMinXNearest   = 1ULL << 16,
   NSAlignMinYNearest   = 1ULL << 17,
   NSAlignMaxXNearest   = 1ULL << 18,
   NSAlignMaxYNearest   = 1ULL << 19,
   NSAlignWidthNearest  = 1ULL << 20,
   NSAlignHeightNearest = 1ULL << 21,
   NSAlignRectFlipped = 1ULL << 63,
   
   // convenience combinations
   NSAlignAllEdgesInward = NSAlignMinXInward|NSAlignMaxXInward|NSAlignMinYInward|NSAlignMaxYInward,
   NSAlignAllEdgesOutward = NSAlignMinXOutward|NSAlignMaxXOutward|NSAlignMinYOutward|NSAlignMaxYOutward,
   NSAlignAllEdgesNearest = NSAlignMinXNearest|NSAlignMaxXNearest|NSAlignMinYNearest|NSAlignMaxYNearest,
};
typedef unsigned long long NSAlignmentOptions;

Constants

NSAlignMinXInward

Specifies that alignment of the minimum X coordinate should be to the nearest inward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMinYInward

Specifies that alignment of the minimum Y coordinate should be to the nearest inward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMaxXInward

Specifies that alignment of the maximum X coordinate should be to the nearest inward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMaxYInward

Specifies that alignment of the maximum X coordinate should be to the nearest inward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignWidthInward

Specifies that alignment of the width should be to the nearest inward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignHeightInward

Specifies that alignment of the height should be to the nearest inward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMinXOutward

Specifies that alignment of the minimum X coordinate should be to the nearest outward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMinYOutward

Specifies that alignment of the minimum Y coordinate should be to the nearest outward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMaxXOutward

Specifies that alignment of the maximum X coordinate should be to the nearest outward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMaxYOutward

Specifies that alignment of the maximum Y coordinate should be to the nearest outward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignWidthOutward

Specifies that alignment of the width should be to the nearest outward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignHeightOutward

Specifies that alignment of the height should be to the nearest outward integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMinXNearest

Specifies that alignment of the minimum X coordinate should be to the nearest integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMinYNearest

Specifies that alignment of the minimum Y coordinate should be to the nearest integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMaxXNearest

Specifies that alignment of the maximum X coordinate should be to the nearest integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignMaxYNearest

Specifies that alignment of the maximum Y coordinate should be to the nearest integral value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignWidthNearest

Specifies that alignment of the width should be to the closest nearest value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignHeightNearest

Specifies that alignment of the height should be to the closest nearest value.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignRectFlipped

This option should be included if the rectangle is in a flipped coordinate system. This allows 0.5 to be treated in a visually consistent way.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignAllEdgesInward

Aligns all edges inward. This is the same as NSAlignMinXInward|NSAlignMaxXInward|NSAlignMinYInward|NSAlignMaxYInward.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignAllEdgesOutward

Aligns all edges outwards. This is the same as NSAlignMinXOutward|NSAlignMaxXOutward|NSAlignMinYOutward|NSAlignMaxYOutward.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

NSAlignAllEdgesNearest

Aligns all edges to the nearest value. This is the same as NSAlignMinXNearest|NSAlignMaxXNearest|NSAlignMinYNearest|NSAlignMaxYNearest.

Available in OS X v10.7 and later.

Declared in NSGeometry.h.

Minimum and Maximum Edges

Defines the minimum and maximum edge constants.

#define NSMinXEdge CGRectMinXEdge
#define NSMinYEdge CGRectMinYEdge
#define NSMaxXEdge CGRectMaxXEdge
#define NSMaxYEdge CGRectMaxYEdge

Constants

NSMinXEdge

The minimum X edge. This is equivalent to CGRectMinXEdge.

Available in OS X v10.5 and later.

Declared in NSGeometry.h.

NSMinYEdge

The minimum Y edge. This is equivalent to CGRectMinYEdge.

Available in OS X v10.5 and later.

Declared in NSGeometry.h.

NSMaxXEdge

The maximum X edge. This is equivalent to CGRectMaxXEdge.

Available in OS X v10.5 and later.

Declared in NSGeometry.h.

NSMaxYEdge

The maximum X edge. This is equivalent to CGRectMaxXEdge.

Available in OS X v10.5 and later.

Declared in NSGeometry.h.

Numeric Constants

NSDecimal Constants

Constants used by NSDecimal.

#define NSDecimalMaxSize (8)
#define NSDecimalNoScale SHRT_MAX

Constants

NSDecimalMaxSize

The maximum size of NSDecimal.

Gives a precision of at least 38 decimal digits, 128 binary positions.

Available in OS X v10.0 and later.

Declared in NSDecimal.h.

NSDecimalNoScale

Specifies that the number of digits allowed after the decimal separator in a decimal number should not be limited.

Available in OS X v10.0 and later.

Declared in NSDecimal.h.

Declared In

NSDecimal.h

NSMapTable Constants

Constants used by NSMapTable.

#define NSNotAnIntMapKey ((const void *)0x80000000)
#define NSNotAnIntegerMapKey ((const void *)NSIntegerMin)
#define NSNotAPointerMapKey ((const void *)0xffffffff)

Constants

NSNotAnIntMapKey

Predefined notAKeyMarker for use with NSMapTableKeyCallBacks. (Deprecated. Use NSNotAnIntegerMapKey instead.)

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

NSNotAnIntegerMapKey

Predefined notAKeyMarker for use with NSMapTableKeyCallBacks.

Available in OS X v10.5 and later.

Declared in NSMapTable.h.

NSNotAPointerMapKey

Predefined notAKeyMarker for use with NSMapTableKeyCallBacks.

Available in OS X v10.0 and later.

Declared in NSMapTable.h.

Discussion

On OS X v10.5 and later, see also the NSMapTable class.

Declared In

NSMapTable.h

NSInteger and NSUInteger Maximum and Minimum Values

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

#define NSIntegerMax    LONG_MAX
#define NSIntegerMin    LONG_MIN
   
#define NSUIntegerMax   ULONG_MAX

Constants

NSIntegerMax

The maximum value for an NSInteger.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSIntegerMin

The minimum value for an NSInteger.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSUIntegerMax

The maximum value for an NSUInteger.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

Declared In

NSObjCRuntime.h

Notifications

Java Setup Notification Names

Notifications sent by the Java bridge to registered observers when a virtual machine is created and initialized.

extern NSString *NSJavaWillSetupVirtualMachineNotification;
extern NSString *NSJavaDidSetupVirtualMachineNotification;
extern NSString *NSJavaWillCreateVirtualMachineNotification;
extern NSString *NSJavaDidCreateVirtualMachineNotification;

Constants

NSJavaWillSetupVirtualMachineNotification

Notification sent before the Java virtual machine is set up.

Available in OS X v10.0 through OS X v10.5.

Deprecated in OS X v10.5.

Declared in NSJavaSetup.h.

NSJavaDidSetupVirtualMachineNotification

Notification sent after the Java virtual machine is set up.

Available in OS X v10.0 through OS X v10.5.

Deprecated in OS X v10.5.

Declared in NSJavaSetup.h.

NSJavaWillCreateVirtualMachineNotification

Notification sent before the Java virtual machine is created.

Available in OS X v10.0 through OS X v10.5.

Deprecated in OS X v10.5.

Declared in NSJavaSetup.h.

NSJavaDidCreateVirtualMachineNotification

Notification sent after the Java virtual machine is created.

Available in OS X v10.0 through OS X v10.5.

Deprecated in OS X v10.5.

Declared in NSJavaSetup.h.

Declared In

NSJavaSetup.h

Exceptions

General Exception Names

Exceptions defined by NSException.

extern NSString *NSGenericException;
extern NSString *NSRangeException;
extern NSString *NSInvalidArgumentException;
extern NSString *NSInternalInconsistencyException;
extern NSString *NSMallocException;
extern NSString *NSObjectInaccessibleException;
extern NSString *NSObjectNotAvailableException;
extern NSString *NSDestinationInvalidException;
extern NSString *NSPortTimeoutException;
extern NSString *NSInvalidSendPortException;
extern NSString *NSInvalidReceivePortException;
extern NSString *NSPortSendException;
extern NSString *NSPortReceiveException;
extern NSString *NSOldStyleException;

Constants

NSGenericException

A generic name for an exception.

You should typically use a more specific exception name.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSRangeException

Name of an exception that occurs when attempting to access outside the bounds of some data, such as beyond the end of a string.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSInvalidArgumentException

Name of an exception that occurs when you pass an invalid argument to a method, such as a nil pointer where a non-nil object is required.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSInternalInconsistencyException

Name of an exception that occurs when an internal assertion fails and implies an unexpected condition within the called code.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSMallocException

Obsolete; not currently used.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSObjectInaccessibleException

Name of an exception that occurs when a remote object is accessed from a thread that should not access it.

See NSConnection’s enableMultipleThreads.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSObjectNotAvailableException

Name of an exception that occurs when the remote side of the NSConnection refused to send the message to the object because the object has never been vended.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSDestinationInvalidException

Name of an exception that occurs when an internal assertion fails and implies an unexpected condition within the distributed objects.

This is a distributed objects–specific exception.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSPortTimeoutException

Name of an exception that occurs when a timeout set on a port expires during a send or receive operation.

This is a distributed objects–specific exception.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSInvalidSendPortException

Name of an exception that occurs when the send port of an NSConnection has become invalid.

This is a distributed objects–specific exception.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSInvalidReceivePortException

Name of an exception that occurs when the receive port of an NSConnection has become invalid.

This is a distributed objects–specific exception.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSPortSendException

Generic error occurred on send.

This is an NSPort-specific exception.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSPortReceiveException

Generic error occurred on receive.

This is an NSPort-specific exception.

Available in OS X v10.0 and later.

Declared in NSException.h.

NSOldStyleException

No longer used.

Available in OS X v10.0 and later.

Declared in NSException.h.

Declared In

NSException.h

Version Numbers

Foundation Version Number

Version of the Foundation framework in the current environment.

double NSFoundationVersionNumber;

Constants

NSFoundationVersionNumber

The version of the Foundation framework in the current environment.

Available in OS X v10.1 and later.

Declared in NSObjCRuntime.h.

Declared In

NSObjCRuntime.h

Foundation Framework Version Numbers

Constants to define Foundation Framework version numbers.

#define NSFoundationVersionNumber10_0    397.40
#define NSFoundationVersionNumber10_1    425.00
#define NSFoundationVersionNumber10_1_1    425.00
#define NSFoundationVersionNumber10_1_2    425.00
#define NSFoundationVersionNumber10_1_3    425.00
#define NSFoundationVersionNumber10_1_4    425.00
#define NSFoundationVersionNumber10_2    462.00
#define NSFoundationVersionNumber10_2_1    462.00
#define NSFoundationVersionNumber10_2_2    462.00
#define NSFoundationVersionNumber10_2_3    462.00
#define NSFoundationVersionNumber10_2_4    462.00
#define NSFoundationVersionNumber10_2_5    462.00
#define NSFoundationVersionNumber10_2_6    462.00
#define NSFoundationVersionNumber10_2_7    462.70
#define NSFoundationVersionNumber10_2_8    462.70
#define NSFoundationVersionNumber10_3    500.00
#define NSFoundationVersionNumber10_3_1    500.00
#define NSFoundationVersionNumber10_3_2    500.30
#define NSFoundationVersionNumber10_3_3    500.54
#define NSFoundationVersionNumber10_3_4    500.56
#define NSFoundationVersionNumber10_3_5    500.56
#define NSFoundationVersionNumber10_3_6    500.56
#define NSFoundationVersionNumber10_3_7    500.56
#define NSFoundationVersionNumber10_3_8    500.56
#define NSFoundationVersionNumber10_3_9    500.58
#define NSFoundationVersionNumber10_4    567.00
#define NSFoundationVersionNumber10_4_1    567.00
#define NSFoundationVersionNumber10_4_2    567.12
#define NSFoundationVersionNumber10_4_3    567.21
#define NSFoundationVersionNumber10_4_4_Intel    567.23
#define NSFoundationVersionNumber10_4_4_PowerPC    567.21
#define NSFoundationVersionNumber10_4_5    567.25
#define NSFoundationVersionNumber10_4_6    567.26
#define NSFoundationVersionNumber10_4_7    567.27
#define NSFoundationVersionNumber10_4_8    567.28
#define NSFoundationVersionNumber10_4_9    567.29
#define NSFoundationVersionNumber10_4_10    567.29
#define NSFoundationVersionNumber10_4_11    567.36
#define NSFoundationVersionNumber10_5    677.00
#define NSFoundationVersionNumber10_5_1    677.10
#define NSFoundationVersionNumber10_5_2 677.15
#define NSFoundationVersionNumber10_5_3 677.19
#define NSFoundationVersionNumber10_5_4 677.19
#define NSFoundationVersionNumber10_5_5 677.21
#define NSFoundationVersionNumber10_5_6 677.22
#define NSFoundationVersionNumber_iOS_2_0    678.24
#define NSFoundationVersionNumber_iOS_2_1  678.26
   
#define NSFoundationVersionNumber_iOS_2_2  678.29

Constants

NSFoundationVersionNumber10_0

Foundation version released in OS X version 10.0.

Available in OS X v10.1 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_1

Foundation version released in OS X version 10.1.

Available in OS X v10.2 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_1_1

Foundation version released in OS X version 10.1.1.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_1_2

Foundation version released in OS X version 10.1.2.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_1_3

Foundation version released in OS X version 10.1.3.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_1_4

Foundation version released in OS X version 10.1.4.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2

Foundation version released in OS X version 10.2.

Available in OS X v10.3 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_1

Foundation version released in OS X version 10.2.1.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_2

Foundation version released in OS X version 10.2.2.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_3

Foundation version released in OS X version 10.2.3.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_4

Foundation version released in OS X version 10.2.4.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_5

Foundation version released in OS X version 10.2.5.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_6

Foundation version released in OS X version 10.2.6.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_7

Foundation version released in OS X version 10.2.7.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_2_8

Foundation version released in OS X version 10.2.8.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3

Foundation version released in OS X version 10.3.

Available in OS X v10.4 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_1

Foundation version released in OS X version 10.3.1.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_2

Foundation version released in OS X version 10.3.2.

Available in OS X v10.4 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_3

Foundation version released in OS X version 10.3.3.

Available in OS X v10.4 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_4

Foundation version released in OS X version 10.3.4.

Available in OS X v10.4 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_5

Foundation version released in OS X version 10.3.5.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_6

Foundation version released in OS X version 10.3.6.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_7

Foundation version released in OS X version 10.3.7.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_8

Foundation version released in OS X version 10.3.8.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_3_9

Foundation version released in OS X version 10.3.9.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4

Foundation version released in OS X version 10.4.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_1

Foundation version released in OS X version 10.4.1.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_2

Foundation version released in OS X version 10.4.2.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_3

Foundation version released in OS X version 10.4.3.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_4_Intel

Foundation version released in OS X version 10.4.4 for Intel.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_4_PowerPC

Foundation version released in OS X version 10.4.4 for PowerPC.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_5

Foundation version released in OS X version 10.4.5.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_6

Foundation version released in OS X version 10.4.6.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_7

Foundation version released in OS X version 10.4.7.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_8

Foundation version released in OS X version 10.4.8.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_9

Foundation version released in OS X version 10.4.9.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_10

Foundation version released in OS X version 10.4.10.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_4_11

Foundation version released in OS X version 10.4.11.

Available in OS X v10.5 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5

Foundation version released in OS X version 10.5.0.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5_1

Foundation version released in OS X version 10.5.1.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5_2

Foundation version released in OS X version 10.5.2.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5_3

Foundation version released in OS X version 10.5.3.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5_4

Foundation version released in OS X version 10.5.4.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5_5

Foundation version released in OS X version 10.5.5.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber10_5_6

Foundation version released in OS X version 10.5.6.

Available in OS X v10.6 and later.

Declared in NSObjCRuntime.h.

NSFoundationVersionNumber_iOS_2_0

Foundation version released in iOS version 2.0.

This constant is only available on iOS.

NSFoundationVersionNumber_iOS_2_1

Foundation version released in iOS version 2.1.

This constant is only available on iOS.

NSFoundationVersionNumber_iOS_2_2

Foundation version released in iOS version 2.2.

This constant is only available on iOS.

Declared In

NSObjCRuntime.h

Did this document help you?

Shop the Apple Online Store (1-800-MY-APPLE), visit an Apple Retail Store, or find a reseller.