Enterprise Objects Framework Release 1.0 Copyright ©1994 by NeXT Computer, Inc.  All Rights Reserved.





Defined Types




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).




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).




NSStringEncoding

DECLARED IN foundation/NSString.h

SYNOPSIS    typedef enum _NSStringEncoding {
NSUnicodeStringEncoding = 0,
NSASCIIStringEncoding,
NSNEXTSTEPStringEncoding,
NSEUCStringEncoding,
NSUTFStringEncoding,
NSISOLatin1StringEncoding,
NSSymbolStringEncoding,
NSNonLossyASCIIStringEncoding
} NSStringEncoding

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
NSEUCStringEncoding 8-bit EUC encoding for Japanese text
NSISOLatin1StringEncoding 8-bit ISO Latin 1 encoding
NSNEXTSTEPStringEncoding 8-bit ASCII encoding with NEXTSTEP extensions (see Appendix C of the NEXTSTEP General Reference)

NSNonLossyASCIIStringEncoding
<<forthcoming>>

NSSymbolStringEncoding <<forthcoming>>

NSUnicodeStringEncoding The canonical Unicode encoding for string objects
NSUTFStringEncoding An 8-bit representation of Unicode characters, suitable for transmission or storage by ASCII-based systems <<should we document this format?>>






Symbolic Constants




NSHashStringLength

DECLARED IN foundation/NSString.h

SYNOPSIS    NSHashStringLength



NSMaximumStringLength

DECLARED IN foundation/NSString.h

SYNOPSIS    NSMaximumStringLength

DESCRIPTION NSMaximumStringLength is the greatest possible length for an NSString.




NSNotFound

DECLARED IN foundation/NSObject.h

SYNOPSIS    NSNotFound

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.






Enumerations




NSStringSearchFlags

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.