Documentation Archive Developer
Search

Defined Types


NSBTreeComparator

Declared In:
Foundation/NSByteStore.h

Synopsis:

typedef int NSBTreeComparator(NSData *, NSData *, const void *);

NSComparisonResult

Declared In:
Foundation/NSObject.h

Synopsis:

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

Description:
An NSComparisonResult indicates 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).


NSHashTableCallBacks

Declared In:
Foundation/NSHashTable.h

Synopsis:

typedef struct {
unsigned (*hash)(NSHashTable *table, const void *);
BOOL (*isEqual)(NSHashTable *table, const void *, const void *);
void (*retain)(NSHashTable *table, const void *);
void (*release)(NSHashTable *table, void *);
NSString *(*describe)(NSHashTable *table, const void *);
} NSHashTableCallBacks;

NSMapTableKeyCallBacks

Declared In:
Foundation/NSMapTable.h

Synopsis:

typedef struct {
unsigned (*hash)(NSMapTable *table, const void *);
BOOL (*isEqual)(NSMapTable *table, const void *, const void *);
void (*retain)(NSMapTable *table, const void *);
void (*release)(NSMapTable *table, void *);
NSString *(*describe)(NSMapTable *table, const void *);
const void *notAKeyMarker;
} NSMapTableKeyCallBacks;

NSMapTableValueCallBacks

Declared In:
Foundation/NSMapTable.h

Synopsis:

typedef struct {
void (*retain)(NSMapTable *table, const void *);
void (*release)(NSMapTable *table, void *);
NSString *(*describe)(NSMapTable *table, const void *);
} NSMapTableValueCallBacks;

NSNotificationCoalescing

Declared In:
Foundation/NSNotificationQueue.h

Synopsis:

typedef enum {
NSNotificationNoCoalescing = 0,
NSNotificationCoalescingOnName = 1,
NSNotificationCoalescingOnSender = 2,
} NSNotificationCoalescing;

NSObjCValue

Declared In:
Foundation/NSInvocation.h

Synopsis:

typedef struct {
enum _NSObjCValueType type;
union {
char charValue;
short shortValue;
long longValue;
long long longlongValue;
float floatValue;
double doubleValue;
SEL selectorValue;
id objectValue;
void *pointerValue;
void *structLocation;
char *cStringLocation;
} value;
} NSObjCValue;

NSPoint

Declared In:
Foundation/NSGeometry.h

Synopsis:

typedef struct _NSPoint {
    float x;
float y;
} NSPoint;


NSPosixFileActivity

Declared In:
Foundation/NSPosixFileDescriptor.h

Synopsis:

typedef enum {
NSPosixNoActivity = 0,
NSPosixReadableActivity = 1,
NSPosixWritableActivity = 2,
NSPosixExceptionalActivity = 4
} NSPosixFileActivity;

NSPostingStyle

Declared In:
Foundation/NSNotificationQueue.h

Synopsis:

typedef enum {
NSPostWhenIdle = 1,
NSPostASAP = 2,
NSPostNow = 3
} NSPostingStyle;

NSRange

Declared In:
Foundation/NSRange.h

Synopsis:

typedef struct _NSRange {
unsigned int location;
unsigned int length;
} NSRange;

Description:
An NSRange describes a portion of a series-such as characters in a string or objects in an NSArray. Its location member gives the start index (0 is the first, as in C arrays), and its length member gives the number of items in the range (and can be zero).


NSRect

Declared In:
Foundation/NSGeometry.h

Synopsis:

typedef struct _NSRect {
NSPoint origin;
NSSize size;
} NSRect;

NSRectEdge

Declared In:
Foundation/NSGeometry.h

Synopsis:

typedef enum _NSRectEdge {
NSMinXEdge = 0,
NSMinYEdge = 1,
NSMaxXEdge = 2,
NSMaxYEdge = 3
} NSRectEdge;

Description:
This enumeration identifies the sides of a rectangle represented by an NSRect.


NSSize

Declared In:
Foundation/NSGeometry.h

Synopsis:

typedef struct _NSSize {
float width;
float height;
} NSSize;

Description:
The values for width and height should never be negative.


NSStringEncoding

Declared In:
Foundation/NSString.h

Synopsis:

typedef unsigned NSStringEncoding;

NSTimeInterval

Declared In:
Foundation/NSDate.h

Synopsis:

typedef double NSTimeInterval;

Description:
Always in seconds; yields sub-millisecond precision over a range of 10000 years.


NSUncaughtExceptionHandler

Declared In:
Foundation/NSException.h

Synopsis:

typedef volatile void NSUncaughtExceptionHandler(NSException *exception);

Enumerations


NSByteOrder

Declared In:
Foundation/NSByteOrder.h

Synopsis:

enum NSByteOrder {
NS_UnknownByteOrder,
NS_LittleEndian,
NS_BigEndian
};

Description:


NSNotFound

Declared In:
Foundation/NSObjCRuntime.h

Synopsis:

enum {
NSNotFound = 0x7fffffff
};

Description:
A method or function return value of NSNotFound indicates that the item requested couldn't be found or doesn't exist. It's 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.


NSOpenStepUnicodeReservedBase

Declared In:
Foundation/NSCharacterSet.h

Synopsis:

enum {
NSOpenStepUnicodeReservedBase = 0xF400
};

Description:


ObjC Types

Declared In:
Foundation/NSInvocation.h

Synopsis:

enum _NSObjCValueType {
NSObjCNoType = 0,
NSObjCVoidType = 'v',
NSObjCCharType = 'c',
NSObjCShortType = 's',
NSObjCLongType = 'l',
NSObjCLonglongType = 'q',
NSObjCFloatType = 'f',
NSObjCDoubleType = 'd',
NSObjCSelectorType = ':',
NSObjCObjectType = '@',
NSObjCStructType = '{',
NSObjCPointerType = '^',
NSObjCStringType = '*',
NSObjCArrayType = '[',
NSObjCUnionType = '(',
NSObjCBitfield = 'b',
};

Search Types

Declared In:
Foundation/NSString.h

Synopsis:

enum {
NSCaseInsensitiveSearch = 1,
NSLiteralSearch = 2,
NSBackwardsSearch = 4,
NSAnchoredSearch = 8
};

Description:
These values represent the options available to many of the string classes' searching and comparison methods. See the NSString class cluster description for details on the effects of these options.


String Encodings

Declared In:
Foundation/NSString.h

Synopsis:

enum {
NSASCIIStringEncoding = 1,
NSNEXTSTEPStringEncoding = 2,
NSJapaneseEUCStringEncoding = 3,
NSUTF8StringEncoding = 4,
NSISOLatin1StringEncoding = 5,
NSSymbolStringEncoding = 6,
NSNonLossyASCIIStringEncoding = 7,
NSShiftJISStringEncoding = 8,
NSISOLatin2StringEncoding = 9,
NSUnicodeStringEncoding = 10,
NSWindowsCP1251StringEncoding = 11,
NSWindowsCP1252StringEncoding = 12,
NSWindowsCP1253StringEncoding = 13,
NSWindowsCP1254StringEncoding = 14,
NSWindowsCP1250StringEncoding = 15,
NSISO2022JPStringEncoding = 21
};

Description:
These values represent the various character encodings supported by the NSString classes. These encodings are documented more fully elsewhere; here are some short descriptions:

Encoding Description
NSASCIIStringEncoding Strict 7-bit ASCII encoding within 8-bit chars
NSNEXTSTEPStringEncoding 8-bit ASCII encoding with NEXTSTEP extensions (see Appendix C of the NEXTSTEP General Reference)
NSUnicodeStringEncoding The canonical Unicode encoding for string objects
NSISOLatin1StringEncoding 8-bit ISO Latin 1 encoding
NSISOLatin2StringEncoding 8-bit ISO Latin 2 encoding
NSSymbolStringEncoding 8-bit Adobe Symbol encoding vector
NSJapaneseEUCStringEncoding 8-bit EUC encoding for Japanese text
NSShiftJISStringEncoding 8-bit Shift-JIS encoding for Japanese text
NSUTF8StringEncoding An 8-bit representation of Unicode characters, suitable for transmission or storage by ASCII-based systems
NSNonLossyASCIIStringEncoding 7-bit verbose ASCII to represent all Unicode characters.
NSWindowsCP1250StringEncoding Microsoft Windows codepage 1250; equivalent to WinLatin2
NSWindowsCP1251StringEncoding Microsoft Windows codepage 1251, encoding Cyrillic characters; equivalent to AdobeStandardCyrillic font encoding
NSWindowsCP1252StringEncoding Microsoft Windows codepage 1252; equivalent to WinLatin1
NSWindowsCP1253StringEncoding Microsoft Windows codepage 1253, encoding Greek characters
NSWindowsCP1254StringEncoding Microsoft Windows codepage 1254, encoding Turkish characters
NSISO2022JPStringEncoding ISO 2022 Japanese encoding for electronic mail

Global Variables


Archiving Exception Names

Declared In:
Foundation/NSArchiver.h

Synopsis:

extern NSString *NSInconsistentArchiveException;

Bundle Notification Names

Declared In:
Foundation/NSBundle.h

Synopsis:

extern NSString *NSBundleLoaded;

Byte Store Exception Names

Declared In:
Foundation/NSByteStore.h

Synopsis:

extern NSString *NSByteStoreLockedException;
extern NSString *NSByteStoreVersionException;
extern NSString *NSBTreeStoreKeyTooLargeException;
extern NSString *NSByteStoreDamagedException;

Connection Exception Names

Declared In:
Foundation/NSConnection.h

Synopsis:

extern NSString *NSFailedAuthenticationException;

Connection Notification Names

Declared In:
Foundation/NSConnection.h

Synopsis:

extern NSString *NSConnectionDidDieNotification;

File Attribute Keys

Declared In:
Foundation/NSFileManager.h

Synopsis:

extern NSString *NSFileType;
extern NSString *NSFileTypeDirectory;
extern NSString *NSFileTypeRegular;
extern NSString *NSFileTypeSymbolicLink;
extern NSString *NSFileTypeSocket;
extern NSString *NSFileTypeCharacterSpecial;
extern NSString *NSFileTypeBlockSpecial;
extern NSString *NSFileTypeUnknown;
extern NSString *NSFileSize;
extern NSString *NSFileModificationDate;
extern NSString *NSFileReferenceCount;
extern NSString *NSFileDeviceIdentifier;
extern NSString *NSFileOwnerAccountNumber;
extern NSString *NSFileGroupOwnerAccountNumber;
extern NSString *NSFilePosixPermissions;
extern NSString *NSFileSystemNumber;
extern NSString *NSFileSystemFileNumber;

Description:
Keys to access the file attribute values contained in the NSDictionary returned from NSFileManager's fileAttributesAtPath:follow:. See the class specification for NSFileManager for details of usage. NSFileDeviceIdentifier is used to access the identifier of a remote device.


File Exception Names

Declared In:
Foundation/NSPosix.h

Synopsis:

extern NSString *NSPosixFileOperationException;

File System Attribute Keys

Declared In:
Foundation/NSFileManager.h

Synopsis:

extern NSString *NSFileSystemSize;
extern NSString *NSFileSystemFreeSize;
extern NSString *NSFileSystemNodes;
extern NSString *NSFileSystemFreeNodes;

General Exception Names

Declared In:
Foundation/NSException.h

Synopsis:

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;
extern NSString *NSInvalidSendPort;
extern NSString *NSInvalidReceivePort;
extern NSString *NSPortSendError;
extern NSString *NSPortReceiveError;
extern NSString *NSCharacterConversionException;

Hash Table Call Backs

Declared In:
Foundation/NSHashTable.h

Synopsis:

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

Description:
NSIntHashCallBacks are for sets of pointer-sized quantities or samller (for example, ints, longs, or unichars).

NSNonOwnedPointerHashCallBacks are for sets of pointers, hashed by address.

NSOwnedPointerHashCallBacks are for sets of pointers, with transfer of ownership upon insertion.

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

NSObjectHashCallBacks are for sets of objects (similar to NSSet)

NSNonRetainedObjectHashCallBacks are for sets of objects, but without retaining/releasing.

Note that you can make your own call back by picking fields among the above call backs.


Language-Dependent Information

Declared In:
Foundation/NSUserDefaults.h

Synopsis:

extern NSString *NSWeekDayNameArray;
extern NSString *NSShortWeekDayNameArray;
extern NSString *NSMonthNameArray;
extern NSString *NSShortMonthNameArray;
extern NSString *NSTimeFormatString;
extern NSString *NSDateFormatString;
extern NSString *NSTimeDateFormatString;
extern NSString *NSShortTimeDateFormatString;
extern NSString *NSCurrencySymbol;
extern NSString *NSDecimalSeparator;
extern NSString *NSThousandsSeparator;
extern NSString *NSInternationalCurrencyString;
extern NSString *NSCurrencyString;
extern NSString *NSDecimalDigits;
extern NSString *NSAMPMDesignation;
extern NSString *NSHourNameDesignations;
extern NSString *NSYearMonthWeekDesignations;
extern NSString *NSEarlierTimeDesignations;
extern NSString *NSLaterTimeDesignations;
extern NSString *NSThisDayDesignations;
extern NSString *NSNextDayDesignations;
extern NSString *NSNextNextDayDesignations;
extern NSString *NSPriorDayDesignations;
extern NSString *NSDateTimeOrdering;

Map Table Key Call Backs

Declared In:
Foundation/NSMapTable.h

Synopsis:

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

Description:
NSIntMapKeyCallBacks are for keys that are pointer-sized quantities or smaller (for example, ints, longs, or unichars).

NSNonOwnedPointerMapKeyCallBacks are for keys that are pointers not freed.

NSNonOwnedPointerOrNullMapKeyCallBacks are for keys that are pointers not freed, or NULL.

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

NSObjectMapKeyCallBacks are for keys that are objects

NSNonRetainedObjectMapKeyCallBacks are for sets of objects, but without retaining/releasing.

Note that you can make your own call back by picking fields among the above call backs.


Map Table Value Call Backs

Declared In:
Foundation/NSMapTable.h

Synopsis:

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

Description:
NSIntMapValueCallBacks are for values that are pointer-sized quantities, such as ints.

NSNonOwnedPointerMapValueCallBacks are for values that are not owned pointers.

NSOwnedPointerMapValueCallBacks are for values that are owned pointers.

NSObjectMapValueCallBacks are for values that are objects.

Note that you can make your own call back by picking fields among the above call backs.


NSConnectionReplyMode

Declared In:
NSConnection.h

Synopsis:

extern NSString *NSConnectionReplyMode;

NSDefaultRunLoopMode

Declared In:
Foundation/NSRunLoop.h

Synopsis:

extern NSString *NSDefaultRunLoopMode;

Port Notification Names

Declared In:
Foundation/NSPort.h

Synopsis:

extern NSString *NSPortDidBecomeInvalidNotification;

PPL Notification Names

Declared In:
Foundation/NPPL.h

Synopsis:

extern NSString *NSPPLDidBecomeDirtyNotification;
extern NSString *NSPPLDidSaveNotification;

Thread Notification Names

Declared In:
Foundation/NSThread.h

Synopsis:

extern NSString *NSBecomingMultiThreaded;
extern NSString *NSThreadExiting;

User Defaults

Declared In:
Foundation/NSUserDefaults.h

Synopsis:

extern NSString *NSGlobalDomain;
extern NSString *NSArgumentDomain;
extern NSString *NSRegistrationDomain;

Zero Constants

Declared In:
Foundation/NSGeometry.h

Synopsis:

extern const NSPoint NSZeroPoint;
extern const NSSize NSZeroSize;
extern const NSRect NSZeroRect;
Copyright © 1997, Apple Computer, Inc. All rights reserved.