Mac Developer Library

Developer

Foundation Framework Reference Foundation Functions Reference

Options
Deployment Target:

On This Page
Language:

Foundation Functions Reference

This document describes the functions and function-like macros defined in the Foundation Framework.

Functions

For additional information about Assertions, see Assertions and Logging Programming Guide.

  • Generates an assertion if a given condition is false.

    Declaration

    Objective-C

    #define NSAssert(condition, desc, ...)

    Parameters

    condition

    An expression that evaluates to YEStrue or NOfalse.

    desc

    An NSString object that contains a printf-style string containing an error message describing the failure condition and placeholders for the arguments.

    ...

    The arguments displayed in the desc string.

    Discussion

    The NSAssert macro evaluates the condition and serves as a front end to the assertion handler.

    Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes the method and class names (or the function name). It then raises an NSInternalInconsistencyException exception. If condition evaluates to NOfalse, the macro invokes handleFailureInMethod:object:file:lineNumber:description: on the assertion handler for the current thread, passing desc as the description string.

    This macro should be used only within Objective-C methods.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined.

    Availability

    Available in OS X v10.0 and later.

  • Generates an assertion if a given condition is false.

    Declaration

    Objective-C

    #define NSAssert1(condition, desc, arg1)

    Parameters

    condition

    An expression that evaluates to YEStrue or NOfalse.

    desc

    An NSString object that contains a printf-style string containing an error message describing the failure condition and a placeholder for a single argument.

    arg1

    An argument to be inserted, in place, into desc.

    Discussion

    The NSAssert1 macro evaluates the condition and serves as a front end to the assertion handler.

    Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes the method and class names (or the function name). It then raises an NSInternalInconsistencyException exception. If condition evaluates to NOfalse, the macro invokes handleFailureInMethod:object:file:lineNumber:description: on the assertion handler for the current thread, passing desc as the description string and arg1 as a substitution variable.

    This macro should be used only within Objective-C methods.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined.

    Availability

    Available in OS X v10.0 and later.

  • Generates an assertion if a given condition is false.

    Declaration

    Objective-C

    #define NSAssert2(condition, desc, arg1, arg2)

    Parameters

    condition

    An expression that evaluates to YEStrue or NOfalse.

    desc

    An NSString object that contains a printf-style string containing an error message describing the failure condition and placeholders for two arguments.

    arg1

    An argument to be inserted, in place, into desc.

    arg2

    An argument to be inserted, in place, into desc.

    Discussion

    The NSAssert2 macro evaluates the condition and serves as a front end to the assertion handler.

    Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes the method and class names (or the function name). It then raises an NSInternalInconsistencyException exception. If condition evaluates to NOfalse, the macro invokes handleFailureInMethod:object:file:lineNumber:description: on the assertion handler for the current thread, passing desc as the description string and arg1 and arg2 as substitution variables.

    This macro should be used only within Objective-C methods.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined.

    Availability

    Available in OS X v10.0 and later.

  • Generates an assertion if a given condition is false.

    Declaration

    Objective-C

    #define NSAssert3(condition, desc, arg1, arg2, arg3)

    Parameters

    condition

    An expression that evaluates to YEStrue or NOfalse.

    desc

    An NSString object that contains a printf-style string containing an error message describing the failure condition and placeholders for three arguments.

    arg1

    An argument to be inserted, in place, into desc.

    arg2

    An argument to be inserted, in place, into desc.

    arg3

    An argument to be inserted, in place, into desc.

    Discussion

    The NSAssert3 macro evaluates the condition and serves as a front end to the assertion handler.

    Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes the method and class names (or the function name). It then raises an NSInternalInconsistencyException exception. If condition evaluates to NOfalse, the macro invokes handleFailureInMethod:object:file:lineNumber:description: on the assertion handler for the current thread, passing desc as the description string and arg1, arg2, and arg3 as substitution variables.

    This macro should be used only within Objective-C methods.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined.

    Availability

    Available in OS X v10.0 and later.

  • Generates an assertion if a given condition is false.

    Declaration

    Objective-C

    #define NSAssert4(condition, desc, arg1, arg2, arg3, arg4)

    Parameters

    condition

    An expression that evaluates to YEStrue or NOfalse.

    desc

    An NSString object that contains a printf-style string containing an error message describing the failure condition and placeholders for four arguments.

    arg1

    An argument to be inserted, in place, into desc.

    arg2

    An argument to be inserted, in place, into desc.

    arg3

    An argument to be inserted, in place, into desc.

    arg4

    An argument to be inserted, in place, into desc.

    Discussion

    The NSAssert4 macro evaluates the condition and serves as a front end to the assertion handler.

    Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes the method and class names (or the function name). It then raises an NSInternalInconsistencyException exception. If condition evaluates to NOfalse, the macro invokes handleFailureInMethod:object:file:lineNumber:description: on the assertion handler for the current thread, passing desc as the description string and arg1, arg2, arg3, and arg4 as substitution variables.

    This macro should be used only within Objective-C methods.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined.

    Availability

    Available in OS X v10.0 and later.

  • Generates an assertion if a given condition is false.

    Declaration

    Objective-C

    #define NSAssert5(condition, desc, arg1, arg2, arg3, arg4, arg5)

    Parameters

    condition

    An expression that evaluates to YEStrue or NOfalse.

    desc

    An NSString object that contains a printf-style string containing an error message describing the failure condition and placeholders for five arguments.

    arg1

    An argument to be inserted, in place, into desc.

    arg2

    An argument to be inserted, in place, into desc.

    arg3

    An argument to be inserted, in place, into desc.

    arg4

    An argument to be inserted, in place, into desc.

    arg5

    An argument to be inserted, in place, into desc.

    Discussion

    The NSAssert5 macro evaluates the condition and serves as a front end to the assertion handler.

    Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes the method and class names (or the function name). It then raises an NSInternalInconsistencyException exception. If condition evaluates to NOfalse, the macro invokes handleFailureInMethod:object:file:lineNumber:description: on the assertion handler for the current thread, passing desc as the description string and arg1, arg2, arg3, arg4, and arg5 as substitution variables.

    This macro should be used only within Objective-C methods.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined.

    Availability

    Available in OS X v10.0 and later.

  • Generates an assertion if the given condition is false.

    Declaration

    Objective-C

    NSCAssert(condition, NSString *description)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    The NSCAssert macro evaluates the condition and serves as a front end to the assertion handler. This macro should be used only within C functions. NSCAssert takes no arguments other than the condition and format string.

    The condition must be an expression that evaluates to true or false. description is a printf-style format string that describes the failure condition.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • NSCAssert1 is one of a series of macros that generate assertions if the given condition is false.

    Declaration

    Objective-C

    NSCAssert1(condition, NSString *description, arg1)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    The NSCAssert1 macro evaluates the condition and serves as a front end to the assertion handler. This macro should be used only within C functions.

    The condition expression must evaluate to true or false. description is a printf-style format string that describes the failure condition. arg1 is an argument to be inserted, in place, into the description.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • NSCAssert2 is one of a series of macros that generate assertions if the given condition is false.

    Declaration

    Objective-C

    NSCAssert2(condition, NSString *description, arg1, arg2)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    The NSCAssert2 macro evaluates the condition and serves as a front end to the assertion handler. This macro should be used only within C functions.

    The condition expression must evaluate to true or false. description is a printf-style format string that describes the failure condition. Each argn is an argument to be inserted, in place, into the description.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • NSCAssert3 is one of a series of macros that generate assertions if the given condition is false.

    Declaration

    Objective-C

    NSCAssert3(condition, NSString *description, arg1, arg2, arg3)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    The NSCAssert3 macro evaluates the condition and serves as a front end to the assertion handler. This macro should be used only within C functions.

    The condition expression must evaluate to true or false. description is a printf-style format string that describes the failure condition. Each argn is an argument to be inserted, in place, into the description.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • NSCAssert4 is one of a series of macros that generate assertions if the given condition is false.

    Declaration

    Objective-C

    NSCAssert4(condition, NSString *description, arg1, arg2, arg3, arg4)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    The NSCAssert4 macro evaluates the condition and serves as a front end to the assertion handler. This macro should be used only within C functions.

    The condition expression must evaluate to true or false. description is a printf-style format string that describes the failure condition. Each argn is an argument to be inserted, in place, into the description.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • NSCAssert5 is one of a series of macros that generate assertions if the given condition is false.

    Declaration

    Objective-C

    NSCAssert5(condition, NSString *description, arg1, arg2, arg3, arg4, arg5)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    The NSCAssert5 macro evaluates the condition and serves as a front end to the assertion handler. This macro should be used only within C functions.

    The condition expression must evaluate to true or false. description is a printf-style format string that describes the failure condition. Each argn is an argument to be inserted, in place, into the description.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • Evaluates the specified parameter.

    Declaration

    Objective-C

    NSCParameterAssert(condition)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    This macro validates a parameter for a C function. Simply provide the parameter as the condition argument. The macro evaluates the parameter and, if the parameter evaluates to false, logs an error message that includes the parameter and then raises an exception.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All macros return void.

    Availability

    Available in OS X v10.0 and later.

  • Validates the specified parameter.

    Declaration

    Objective-C

    NSParameterAssert(condition)

    Discussion

    Assertions evaluate a condition and, if the condition evaluates to false, call the assertion handler for the current thread, passing it a format string and a variable number of arguments. Each thread has its own assertion handler, which is an object of class NSAssertionHandler. When invoked, an assertion handler prints an error message that includes method and class names (or the function name). It then raises an NSInternalInconsistencyException exception.

    This macro validates a parameter for an Objective-C method. Simply provide the parameter as the condition argument. The macro evaluates the parameter and, if it is false, it logs an error message that includes the parameter and then raises an exception.

    Assertions are disabled if the preprocessor macro NS_BLOCK_ASSERTIONS is defined. All assertion macros return void.

    Availability

    Available in OS X v10.0 and later.

For additional information on generating strings files see Using Strings Files for User-Facing Text.

  • Returns a localized version of a string.

    Declaration

    Objective-C

    NSString *NSLocalizedString(NSString *key, NSString *comment)

    Parameters

    key

    The key for a string in the default table.

    comment

    The comment to place above the key-value pair in the strings file.

    Return Value

    The result of invoking localizedStringForKey:value:table: on the main bundle passing nil as the table.

    Discussion

    Use this macro to generate the default Localizable.strings file from your code using the genstrings utility. You can specify Unicode characters in key using \\Uxxxx—see the -u option for the genstrings utility. The initial value for key in the strings file will be key. Use the NSLocalizedStringWithDefaultValue macro to specify another value for key.

    For more information, see NSBundle.

    Special Considerations

    In OS X v10.4 and earlier, to ensure correct parsing by the genstrings utility, the key parameter must not contain any high-ASCII characters.

    Availability

    Available in OS X v10.0 and later.

  • Returns a localized version of a string from the specified table.

    Declaration

    Objective-C

    NSString *NSLocalizedStringFromTable(NSString *key, NSString *tableName, NSString *comment)

    Parameters

    key

    The key for a string in the specified table.

    tableName

    The name of the table containing the key-value pairs. Also, the suffix for the strings file (a file with the .strings extension) to store the localized string.

    comment

    The comment to place above the key-value pair in the strings file.

    Return Value

    The result of invoking localizedStringForKey:value:table: on the main bundle, passing it the specified key and tableName.

    Discussion

    Use this macro to generate a specific strings files named [tableName].strings from your code using the genstrings utility. You can specify Unicode characters in key using \\Uxxxx—see the -u option for for the genstrings utility. The initial value for key in the strings file will be key. Use the NSLocalizedStringWithDefaultValue macro to specify another value for key.

    For more information, see NSBundle.

    Special Considerations

    In OS X v10.4 and earlier, to ensure correct parsing by the genstrings utility, the key parameter must not contain any high-ASCII characters.

    Availability

    Available in OS X v10.0 and later.

  • Returns a localized version of a string.

    Declaration

    Objective-C

    NSString *NSLocalizedStringFromTableInBundle(NSString *key, NSString *tableName, NSBundle *bundle, NSString *comment)

    Parameters

    key

    The key for a string in the specified table.

    tableName

    The name of the table containing the key-value pairs. Also, the suffix for the strings file (a file with the .strings extension) to store the localized string.

    bundle

    The bundle containing the strings file.

    comment

    The comment to place above the key-value pair in the strings file.

    Return Value

    The result of sending localizedStringForKey:value:table: to bundle, passing the specified key and tableName where the value parameter is nil.

    Discussion

    Use this macro to generate a strings files named [tableName].strings located in bundle from your code using the genstrings utility. You can specify Unicode characters in key using \\Uxxxx—see the -u option for for the genstrings utility. The initial value for key in the strings file will be key. Use the NSLocalizedStringWithDefaultValue macro to specify another value for key.

    For more information, see NSBundle.

    Special Considerations

    In OS X v10.4 and earlier, to ensure correct parsing by the genstrings utility, the key parameter must not contain any high-ASCII characters.

    Availability

    Available in OS X v10.0 and later.

  • Returns a localized version of a string.

    Declaration

    Objective-C

    NSString *NSLocalizedStringWithDefaultValue(NSString *key, NSString *tableName, NSBundle *bundle, NSString *value, NSString *comment)

    Parameters

    key

    The key for a string in the specified table.

    tableName

    The name of the table containing the key-value pairs. Also, the suffix for the strings file (a file with the .strings extension) to store the localized string.

    bundle

    The bundle containing the strings file.

    value

    The value to return if key is nil or if a localized string for key can’t be found in the table.

    comment

    The comment to place above the key-value pair in the strings file.

    Return Value

    The result of sending localizedStringForKey:value:table: to bundle, passing the specified key, value, and tableName.

    Discussion

    Use this macro to generate a strings files named [tableName].strings located in bundle from your code using the genstrings utility. The initial value for key in the strings file will be value. You can specify Unicode characters in key using \\Uxxxx—see the -u option for for the genstrings utility.

    For more information, see NSBundle.

    Special Considerations

    In OS X v10.4 and earlier, to ensure correct parsing by the genstrings utility, the key parameter must not contain any high-ASCII characters.

    Availability

    Available in OS X v10.2 and later.

You can also use the class NSDecimalNumber for decimal arithmetic.

You can find the following macros implemented in NSException.h. They are obsolete and should not be used. See Exception Programming Topics for information on how to handle exceptions.

  • Marks the start of the exception-handling domain.

    Declaration

    Objective-C

    NS_DURING

    Discussion

    The NS_DURING macro marks the start of the exception-handling domain for a section of code. (The NS_HANDLERmacro marks the end of the domain.) Within the exception-handling domain you can raise an exception, giving the local exception handler (or lower exception handlers) a chance to handle it.

    Availability

    Available in OS X v10.0 and later.

  • Marks the end of the local event handler.

    Declaration

    Objective-C

    NS_ENDHANDLER

    Discussion

    The NS_ENDHANDLER marks the end of a section of code that is a local exception handler. (The NS_HANDLERmacros marks the beginning of this section.) If an exception is raised in the exception handling domain marked off by the NS_DURING and NS_HANDLER, the local exception handler (if specified) is given a chance to handle the exception.

    Availability

    Available in OS X v10.0 and later.

  • Marks the end of the exception-handling domain and the start of the local exception handler.

    Declaration

    Objective-C

    NS_HANDLER

    Discussion

    The NS_HANDLER macro marks end of a section of code that is an exception-handling domain while at the same time marking the beginning of a section of code that is a local exception handler for that domain. (The NS_DURING macro marks the beginning of the exception-handling domain; the NS_ENDHANDLER marks the end of the local exception handler.) If an exception is raised in the exception-handling domain, the local exception handler is first given the chance to handle the exception before lower-level handlers are given a chance.

    Availability

    Available in OS X v10.0 and later.

  • Permits program control to exit from an exception-handling domain with a value of a specified type.

    Declaration

    Objective-C

    NS_VALUERETURN(val, type)

    Parameters

    val

    A value to preserve beyond the exception-handling domain.

    type

    The type of the value specified in val.

    Discussion

    The NS_VALUERETURN macro returns program control to the caller out of the exception-handling domain—that is, a section of code between the NS_DURING and NS_HANDLER macros that might raise an exception. The specified value (of the specified type) is returned to the caller. The standard return statement does not work as expected in the exception-handling domain.

    Availability

    Available in OS X v10.0 and later.

  • Permits program control to exit from an exception-handling domain.

    Declaration

    Objective-C

    NS_VOIDRETURN

    Discussion

    The NS_VOIDRETURN macro returns program control to the caller out of the exception-handling domain—that is, a section of code between the NS_DURING and NS_HANDLER macros that might raise an exception. The standard return statement does not work as expected in the exception-handling domain.

    Availability

    Available in OS X v10.0 and later.

  • NSJavaBundleCleanup Available in OS X v10.2 through OS X v10.5

    This function has been deprecated.

    Declaration

    Objective-C

    void NSJavaBundleCleanup ( NSBundle *bundle, NSDictionary *plist );

    Availability

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

    Deprecated in OS X v10.5.

  • NSJavaBundleSetup Available in OS X v10.2 through OS X v10.5

    This function has been deprecated.

    Declaration

    Objective-C

    id NSJavaBundleSetup ( NSBundle *bundle, NSDictionary *plist );

    Availability

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

    Deprecated in OS X v10.5.

  • NSJavaClassesForBundle Available in OS X v10.2 through OS X v10.5

    Loads the Java classes located in the specified bundle.

    Declaration

    Objective-C

    NSArray * NSJavaClassesForBundle ( NSBundle *bundle, BOOL usesyscl, id *vm );

    Discussion

    Loads and returns the Java classes in the specified bundle. If the Java virtual machine is not loaded, load it first. A reference to the Java virtual machine is returned in the vm parameter. You can pass nil for the vm parameter if you do not want this information. Pass NOfalse for usesyscl if you want to use a new instance of the class loader to load the classes; otherwise, the system can reuse an existing instance of the class loader. If you pass NOfalse for usesyscl, the new class loader will be released when you are done with it; otherwise, the class loader will be cached for use next time.

    Availability

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

    Deprecated in OS X v10.5.

  • NSJavaClassesFromPath Available in OS X v10.2 through OS X v10.5

    Loads the Java classes located at the specified path.

    Declaration

    Objective-C

    NSArray * NSJavaClassesFromPath ( NSArray *path, NSArray *wanted, BOOL usesyscl, id *vm );

    Discussion

    Loads and returns the Java classes in the specified bundle. If the Java virtual machine is not loaded, load it first. A reference to the Java virtual machine is returned in the vm parameter. You can pass nil for the vm parameter if you do not want this information. Pass an array of names of classes to load in the wanted parameter. If you pass nil for the wanted parameter, all classes at the specified path will be loaded. Pass NOfalse for usesyscl if you want to use a new instance of the class loader to load the classes; otherwise, the system can reuse an existing instance of the class loader. If you pass NOfalse for usesyscl, the new class loader will be released when you are done with it; otherwise, the class loader will be cached for use next time.

    Availability

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

    Deprecated in OS X v10.5.

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

    Returns a Boolean value that indicates whether a virtual machine is needed or if Java classes are provided.

    Declaration

    Objective-C

    BOOL NSJavaNeedsToLoadClasses ( NSDictionary *plist );

    Discussion

    Returns YEStrue if a virtual machine is needed or if a virtual machine already exists and there’s an indication that Java classes are provided.

    Availability

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

    Deprecated in OS X v10.5.

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

    Returns a Boolean value that indicates whether a Java virtual machine is required.

    Declaration

    Objective-C

    BOOL NSJavaNeedsVirtualMachine ( NSDictionary *plist );

    Discussion

    Returns YEStrue if plist contains a key saying that it requires Java.

    Availability

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

    Deprecated in OS X v10.5.

  • NSJavaObjectNamedInPath Available in OS X v10.2 through OS X v10.5

    Creates an instance of the named class using the class loader previously specified at the given path.

    Declaration

    Objective-C

    id NSJavaObjectNamedInPath ( NSString *name, NSArray *path );

    Discussion

    Returns a new instance of the class name. The class loader must be already be set up for the specified path (you can do this using a function such as NSJavaClassesFromPath).

    Availability

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

    Deprecated in OS X v10.5.

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

    Returns a Boolean value that indicates whether Java classes are provided.

    Declaration

    Objective-C

    BOOL NSJavaProvidesClasses ( NSDictionary *plist );

    Discussion

    Returns YEStrue if plist contains an NSJavaPath key.

    Availability

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

    Deprecated in OS X v10.5.

  • NSJavaSetup Available in OS X v10.2 through OS X v10.5

    Loads the Java virtual machine with specified parameters.

    Declaration

    Objective-C

    id NSJavaSetup ( NSDictionary *plist );

    Discussion

    Part of the Java-to-Objective-C bridge. You normally shouldn’t use it yourself.

    You can pass nil for the plist dictionary, in which case the Java virtual machine will not be loaded, so you should probably just use NSJavaSetupVirtualMachine instead. The plist dictionary may contain the following key-value pairs.

    • NSJavaRoot—An NSString indicating the root of the location where the application’s classes are.

    • NSJavaPath—An NSArray of NSStrings, each string containing one component of a class path whose components will be prepended by NSJavaRoot if they are not absolute locations.

    • NSJavaUserPath—An NSString indicating another segment of the class path so that the application developer can customize where the class loader should search for classes. When searching for classes, this path is searched after the application’s class path so that one cannot replace the classes used by the application.

    • NSJavaLibraryPath—An NSArray of NSStrings, each string containing one component of a path to search for dynamic shared libraries needed by Java wrappers.

    • NSJavaClasses—An NSArray of NSStrings, each string containing the name of one class that the VM should load so that their associated frameworks will be loaded.

    Availability

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

    Deprecated in OS X v10.5.

  • NSJavaSetupVirtualMachine Available in OS X v10.2 through OS X v10.5

    Sets up the Java virtual machine.

    Declaration

    Objective-C

    id NSJavaSetupVirtualMachine ( void );

    Discussion

    Sets up and returns a reference to the Java virtual machine.

    Availability

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

    Deprecated in OS X v10.5.

  • Returns a string encoding a file type code.

    Declaration

    Swift

    func NSFileTypeForHFSTypeCode(_ hfsFileTypeCode: OSType) -> String!

    Objective-C

    NSString * NSFileTypeForHFSTypeCode ( OSType hfsFileTypeCode );

    Parameters

    hfsFileTypeCode

    An HFS file type code.

    Return Value

    A string that encodes hfsFileTypeCode.

    Discussion

    For more information, see HFS File Types.

    Availability

    Available in OS X v10.0 and later.

  • Returns a file type code.

    Declaration

    Swift

    func NSHFSTypeCodeFromFileType(_ fileTypeString: String!) -> OSType

    Objective-C

    OSType NSHFSTypeCodeFromFileType ( NSString *fileTypeString );

    Parameters

    fileTypeString

    A string of the sort encoded by NSFileTypeForHFSTypeCode().

    Return Value

    The HFS file type code corresponding to fileTypeString, or 0 if it cannot be found.

    Discussion

    For more information, see HFS File Types.

    Availability

    Available in OS X v10.0 and later.

  • Returns a string encoding a file type.

    Declaration

    Swift

    func NSHFSTypeOfFile(_ fullFilePath: String!) -> String!

    Objective-C

    NSString * NSHFSTypeOfFile ( NSString *fullFilePath );

    Parameters

    fullFilePath

    The full absolute path of a file.

    Return Value

    A string that encodes fullFilePath‘s HFS file type, or nil if the operation was not successful

    Discussion

    For more information, see HFS File Types.

    Availability

    Available in OS X v10.0 and later.

  • Creates and returns a new instance of a given class.

    Declaration

    Objective-C

    id NSAllocateObject ( Class aClass, NSUInteger extraBytes, NSZone *zone );

    Parameters

    aClass

    The class of which to create an instance.

    extraBytes

    The number of extra bytes required for indexed instance variables (this value is typically 0).

    zone

    The zone in which to create the new instance (pass NULL to specify the default zone).

    Return Value

    A new instance of aClass or nil if an instance could not be created.

    Availability

    Available in OS X v10.0 and later.

  • NSCopyObject (OS X v10.8)

    Creates an exact copy of an object.

    Declaration

    Objective-C

    id NSCopyObject ( id object, NSUInteger extraBytes, NSZone *zone );

    Parameters

    object

    The object to copy.

    extraBytes

    The number of extra bytes required for indexed instance variables (this value is typically 0).

    zone

    The zone in which to create the new instance (pass NULL to specify the default zone).

    Return Value

    A new object that’s an exact copy of anObject, or nil if object is nil or if object could not be copied.

    Special Considerations

    This function is dangerous and very difficult to use correctly. It's use as part of copyWithZone: by any class that can be subclassed, is highly error prone. Under GC or when using Objective-C 2.0, the zone is completely ignored.

    This function is likely to be deprecated after OS X v10.6.

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.8.

  • Destroys an existing object.

    Declaration

    Objective-C

    void NSDeallocateObject ( id object );

    Parameters

    object

    An object.

    Discussion

    This function deallocates object, which must have been allocated using NSAllocateObject.

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSAllocateObject

  • Decrements the specified object’s reference count.

    Declaration

    Objective-C

    BOOL NSDecrementExtraRefCountWasZero ( id object );

    Parameters

    object

    An object.

    Return Value

    NOfalse if anObject had an extra reference count, or YEStrue if anObject didn’t have an extra reference count—indicating that the object should be deallocated (with dealloc).

    Discussion

    Decrements the “extra reference” count of anObject. Newly created objects have only one actual reference, so that a single release message results in the object being deallocated. Extra references are those beyond the single original reference and are usually created by sending the object a retain message. Your code should generally not use these functions unless it is overriding the retain or release methods.

    Availability

    Available in OS X v10.0 and later.

  • Returns the specified object’s reference count.

    Declaration

    Objective-C

    NSUInteger NSExtraRefCount ( id object );

    Parameters

    object

    An object.

    Return Value

    The current reference count of object.

    Discussion

    This function is used in conjunction with NSIncrementExtraRefCount and NSDecrementExtraRefCountWasZero in situations where you need to override an object’s retain and release methods.

    Availability

    Available in OS X v10.0 and later.

  • Increments the specified object’s reference count.

    Declaration

    Objective-C

    void NSIncrementExtraRefCount ( id object );

    Parameters

    object

    An object.

    Discussion

    This function increments the “extra reference” count of object. Newly created objects have only one actual reference, so that a single release message results in the object being deallocated. Extra references are those beyond the single original reference and are usually created by sending the object a retain message. Your code should generally not use these functions unless it is overriding the retain or release methods.

    Availability

    Available in OS X v10.0 and later.

  • Indicates whether an object should be retained.

    Declaration

    Objective-C

    BOOL NSShouldRetainWithZone ( id anObject, NSZone *requestedZone );

    Parameters

    anObject

    An object.

    requestedZone

    A memory zone.

    Return Value

    Returns YEStrue if requestedZone is NULL, the default zone, or the zone in which anObject was allocated; otherwise NOfalse.

    Discussion

    This function is typically called from inside an NSObject’s copyWithZone:, when deciding whether to retain anObject as opposed to making a copy of it.

    Availability

    Available in OS X v10.0 and later.

  • Logs an error message to the Apple System Log facility.

    Declaration

    Objective-C

    void NSLog ( NSString *format, ... );

    Discussion

    Simply calls NSLogv, passing it a variable number of arguments.

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSLogv

  • Logs an error message to the Apple System Log facility.

    Declaration

    Swift

    func NSLogv(_ format: String, _ args: CVaListPointer)

    Objective-C

    void NSLogv ( NSString *format, va_list args );

    Discussion

    Logs an error message to the Apple System Log facility (see man 3 asl). If the STDERR_FILENO file descriptor has been redirected away from the default or is going to a tty, it will also be written there. If you want to direct output elsewhere, you need to use a custom logging facility.

    The message consists of a timestamp and the process ID prefixed to the string you pass in. You compose this string with a format string, format, and one or more arguments to be inserted into the string. The format specification allowed by these functions is that which is understood by NSString’s formatting capabilities (which is not necessarily the set of format escapes and flags understood by printf). The supported format specifiers are described in String Format Specifiers. A final hard return is added to the error message if one is not present in the format.

    In general, you should use the NSLog function instead of calling this function directly. If you do use this function directly, you must have prepared the variable argument list in the args argument by calling the standard C macro va_start. Upon completion, you must similarly call the standard C macro va_end for this list.

    Output from NSLogv is serialized, in that only one thread in a process can be doing the writing/logging described above at a time. All attempts at writing/logging a message complete before the next thread can begin its attempts.

    The effects of NSLogv are not serialized with subsystems other than those discussed above (such as the standard I/O package) and do not produce side effects on those subsystems (such as causing buffered output to be flushed, which may be undesirable).

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSLog

  • Returns a Boolean value that indicates whether two given ranges are equal.

    Declaration

    Swift

    func NSEqualRanges(_ range1: NSRange, _ range2: NSRange) -> Bool

    Objective-C

    BOOL NSEqualRanges ( NSRange range1, NSRange range2 );

    Return Value

    YEStrue if range1 and range2 have the same locations and lengths.

    Availability

    Available in OS X v10.0 and later.

  • Returns the intersection of the specified ranges.

    Declaration

    Swift

    func NSIntersectionRange(_ range1: NSRange, _ range2: NSRange) -> NSRange

    Objective-C

    NSRange NSIntersectionRange ( NSRange range1, NSRange range2 );

    Return Value

    A range describing the intersection of range1 and range2—that is, a range containing the indices that exist in both ranges.

    Discussion

    If the returned range’s length field is 0, then the two ranges don’t intersect, and the value of the location field is undefined.

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSUnionRange

  • Returns a Boolean value that indicates whether a specified position is in a given range.

    Declaration

    Swift

    func NSLocationInRange(_ loc: Int, _ range: NSRange) -> Bool

    Objective-C

    BOOL NSLocationInRange ( NSUInteger loc, NSRange range );

    Return Value

    YEStrue if loc lies within range—that is, if it’s greater than or equal to range.location and less than range.location plus range.length.

    Availability

    Available in OS X v10.0 and later.

  • Creates a new NSRange from the specified values.

    Declaration

    Swift

    func NSMakeRange(_ loc: Int, _ len: Int) -> NSRange

    Objective-C

    NSRange NSMakeRange ( NSUInteger loc, NSUInteger len );

    Return Value

    An NSRange with location location and length length.

    Availability

    Available in OS X v10.0 and later.

  • Returns the sum of the location and length of the range.

    Declaration

    Swift

    func NSMaxRange(_ range: NSRange) -> Int

    Objective-C

    NSUInteger NSMaxRange ( NSRange range );

    Return Value

    The sum of the location and length of the range—that is, range.location + range.length.

    Availability

    Available in OS X v10.0 and later.

  • Returns a range from a textual representation.

    Declaration

    Swift

    func NSRangeFromString(_ aString: String) -> NSRange

    Objective-C

    NSRange NSRangeFromString ( NSString *aString );

    Discussion

    Scans aString for two integers which are used as the location and length values, in that order, to create an NSRange struct. If aString only contains a single integer, it is used as the location value. If aString does not contain any integers, this function returns an NSRange struct whose location and length values are both 0.

    Availability

    Available in OS X v10.0 and later.

  • Returns a string representation of a range.

    Declaration

    Swift

    func NSStringFromRange(_ range: NSRange) -> String

    Objective-C

    NSString * NSStringFromRange ( NSRange range );

    Return Value

    A string of the form “{a, b}”, where a and b are non-negative integers representing aRange.

    Availability

    Available in OS X v10.0 and later.

  • Returns the union of the specified ranges.

    Declaration

    Swift

    func NSUnionRange(_ range1: NSRange, _ range2: NSRange) -> NSRange

    Objective-C

    NSRange NSUnionRange ( NSRange range1, NSRange range2 );

    Return Value

    A range covering all indices in and between range1 and range2. If one range is completely contained in the other, the returned range is equal to the larger range.

    Availability

    Available in OS X v10.0 and later.

  • Returns a Boolean value that indicates whether one rectangle completely encloses another.

    Declaration

    Swift

    func NSContainsRect(_ aRect: NSRect, _ bRect: NSRect) -> Bool

    Objective-C

    BOOL NSContainsRect ( NSRect aRect, NSRect bRect );

    Return Value

    YEStrue if aRect completely encloses bRect. For this condition to be true, bRect cannot be empty, and must not extend beyond aRect in any direction.

    Availability

    Available in OS X v10.0 and later.

  • Divides a rectangle into two new rectangles.

    Declaration

    Swift

    func NSDivideRect(_ inRect: NSRect, _ slice: UnsafeMutablePointer<NSRect>, _ rem: UnsafeMutablePointer<NSRect>, _ amount: CGFloat, _ edge: NSRectEdge)

    Objective-C

    void NSDivideRect ( NSRect inRect, NSRect *slice, NSRect *rem, CGFloat amount, NSRectEdge edge );

    Discussion

    Creates two rectangles—slice and rem—from inRect, by dividing inRect with a line that’s parallel to the side of inRect specified by edge. The size of slice is determined by amount, which specifies the distance from edge.

    slice and rem must not be NULL.

    For more information, see NSRectEdge.

    Availability

    Available in OS X v10.0 and later.

  • Returns a Boolean value that indicates whether the two rectangles are equal.

    Declaration

    Swift

    func NSEqualRects(_ aRect: NSRect, _ bRect: NSRect) -> Bool

    Objective-C

    BOOL NSEqualRects ( NSRect aRect, NSRect bRect );

    Return Value

    YEStrue if aRect and bRect are identical, otherwise NOfalse.

    Availability

    Available in OS X v10.0 and later.

  • Returns a Boolean value that indicates whether a given rectangle is empty.

    Declaration

    Swift

    func NSIsEmptyRect(_ aRect: NSRect) -> Bool

    Objective-C

    BOOL NSIsEmptyRect ( NSRect aRect );

    Return Value

    YEStrue if aRect encloses no area at all—that is, if its width or height is 0 or negative, otherwise NOfalse.

    Availability

    Available in OS X v10.0 and later.

  • Returns the height of a given rectangle.

    Declaration

    Swift

    func NSHeight(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSHeight ( NSRect aRect );

    Return Value

    The height of aRect.

    Availability

    Available in OS X v10.0 and later.

  • Insets a rectangle by a specified amount.

    Declaration

    Swift

    func NSInsetRect(_ aRect: NSRect, _ dX: CGFloat, _ dY: CGFloat) -> NSRect

    Objective-C

    NSRect NSInsetRect ( NSRect aRect, CGFloat dX, CGFloat dY );

    Return Value

    A copy of aRect, altered by moving the two sides that are parallel to the y axis inward by dX, and the two sides parallel to the x axis inwards by dY.

    Availability

    Available in OS X v10.0 and later.

  • Adjusts the sides of a rectangle to integer values.

    Declaration

    Swift

    func NSIntegralRect(_ aRect: NSRect) -> NSRect

    Objective-C

    NSRect NSIntegralRect ( NSRect aRect );

    Return Value

    A copy of aRect, expanded outward just enough to ensure that none of its four defining values (x, y, width, and height) have fractional parts. If the width or height of aRect is 0 or negative, this function returns a rectangle with origin at (0.0, 0.0) and with zero width and height.

    Availability

    Available in OS X v10.0 and later.

  • Adjusts the sides of a rectangle to integral values using the specified options.

    Declaration

    Swift

    func NSIntegralRectWithOptions(_ aRect: NSRect, _ opts: NSAlignmentOptions) -> NSRect

    Objective-C

    NSRect NSIntegralRectWithOptions ( NSRect aRect, NSAlignmentOptions opts );

    Return Value

    A copy of aRect, modified based on the options. The options are defined in NSAlignmentOptions.

    Availability

    Available in OS X v10.7 and later.

    See Also

    NSIntegralRect

  • Calculates the intersection of two rectangles.

    Declaration

    Swift

    func NSIntersectionRect(_ aRect: NSRect, _ bRect: NSRect) -> NSRect

    Objective-C

    NSRect NSIntersectionRect ( NSRect aRect, NSRect bRect );

    Return Value

    The graphic intersection of aRect and bRect. If the two rectangles don’t overlap, the returned rectangle has its origin at (0.0, 0.0) and zero width and height (including situations where the intersection is a point or a line segment).

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSUnionRect

  • Returns a Boolean value that indicates whether two rectangles intersect.

    Declaration

    Swift

    func NSIntersectsRect(_ aRect: NSRect, _ bRect: NSRect) -> Bool

    Objective-C

    BOOL NSIntersectsRect ( NSRect aRect, NSRect bRect );

    Return Value

    YEStrue if aRect intersects bRect, otherwise NOfalse. Returns NOfalse if either aRect or bRect has a width or height that is 0.

    Availability

    Available in OS X v10.0 and later.

  • Creates a new NSRect from the specified values.

    Declaration

    Swift

    func NSMakeRect(_ x: CGFloat, _ y: CGFloat, _ w: CGFloat, _ h: CGFloat) -> NSRect

    Objective-C

    NSRect NSMakeRect ( CGFloat x, CGFloat y, CGFloat w, CGFloat h );

    Return Value

    An NSRect having the specified origin of [x, y] and size of [w, h].

    Availability

    Available in OS X v10.0 and later.

  • Returns the largest x coordinate of a given rectangle.

    Declaration

    Swift

    func NSMaxX(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSMaxX ( NSRect aRect );

    Return Value

    The largest x coordinate value within aRect.

    Availability

    Available in OS X v10.0 and later.

  • Returns the largest y coordinate of a given rectangle.

    Declaration

    Swift

    func NSMaxY(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSMaxY ( NSRect aRect );

    Return Value

    The largest y coordinate value within aRect.

    Availability

    Available in OS X v10.0 and later.

  • Returns the x coordinate of a given rectangle’s midpoint.

    Declaration

    Swift

    func NSMidX(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSMidX ( NSRect aRect );

    Return Value

    Returns the x coordinate of the center of aRect.

    Availability

    Available in OS X v10.0 and later.

  • Returns the y coordinate of a given rectangle’s midpoint.

    Declaration

    Swift

    func NSMidY(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSMidY ( NSRect aRect );

    Return Value

    The y coordinate of aRect’s center point.

    Availability

    Available in OS X v10.0 and later.

  • Returns the smallest x coordinate of a given rectangle.

    Declaration

    Swift

    func NSMinX(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSMinX ( NSRect aRect );

    Return Value

    The smallest x coordinate value within aRect.

    Availability

    Available in OS X v10.0 and later.

  • Returns the smallest y coordinate of a given rectangle.

    Declaration

    Swift

    func NSMinY(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSMinY ( NSRect aRect );

    Return Value

    The smallest y coordinate value within aRect.

    Availability

    Available in OS X v10.0 and later.

  • Returns a Boolean value that indicates whether the point is in the specified rectangle.

    Declaration

    Swift

    func NSMouseInRect(_ aPoint: NSPoint, _ aRect: NSRect, _ flipped: Bool) -> Bool

    Objective-C

    BOOL NSMouseInRect ( NSPoint aPoint, NSRect aRect, BOOL flipped );

    Return Value

    YEStrue if the hot spot of the cursor lies inside a given rectangle, otherwise NOfalse.

    Discussion

    This method assumes an unscaled and unrotated coordinate system. Specify YEStrue for flipped if the underlying view uses a flipped coordinate system.

    Point-in-rectangle functions generally assume that the bottom edge of a rectangle is outside of the rectangle boundaries, while the upper edge is inside the boundaries. This method views aRect from the point of view of the user—that is, this method always treats the bottom edge of the rectangle as the one closest to the bottom edge of the user’s screen. By making this adjustment, this function ensures consistent mouse-detection behavior from the user’s perspective.

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSPointInRect

  • Offsets the rectangle by the specified amount.

    Declaration

    Swift

    func NSOffsetRect(_ aRect: NSRect, _ dX: CGFloat, _ dY: CGFloat) -> NSRect

    Objective-C

    NSRect NSOffsetRect ( NSRect aRect, CGFloat dX, CGFloat dY );

    Return Value

    A copy of aRect, with its location shifted by dX along the x axis and by dY along the y axis.

    Availability

    Available in OS X v10.0 and later.

  • Returns a Boolean value that indicates whether a given point is in a given rectangle.

    Declaration

    Swift

    func NSPointInRect(_ aPoint: NSPoint, _ aRect: NSRect) -> Bool

    Objective-C

    BOOL NSPointInRect ( NSPoint aPoint, NSRect aRect );

    Return Value

    YEStrue if aPoint is located within the rectangle represented by aRect, otherwise NOfalse.

    Discussion

    Point-in-rectangle functions generally assume that the “upper” and “left” edges of a rectangle are inside the rectangle boundaries, while the “lower” and “right” edges are outside the boundaries. This method treats the “upper” and “left” edges of the rectangle as the ones containing the origin of the rectangle.

    Special Considerations

    The meanings of “upper” and “lower” (and “left” and “right”) are relative to the current coordinate system and the location of the rectangle. For a rectangle of positive height located in positive x and y coordinates:

    • In the default OS X desktop coordinate system—where the origin is at the bottom left—the rectangle edge closest to the bottom of the screen is the “upper” edge (and is considered inside the rectangle).

    • On iOS and in a flipped coordinate system on OS X desktop—where the origin is at the top left—the rectangle edge closest to the bottom of the screen is the “lower” edge (and is considered outside the rectangle).

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSMouseInRect

  • Returns a rectangle from a text-based representation.

    Declaration

    Swift

    func NSRectFromString(_ aString: String) -> NSRect

    Objective-C

    NSRect NSRectFromString ( NSString *aString );

    Discussion

    Scans aString for four numbers which are used as the x and y coordinates and the width and height, in that order, to create an NSPoint object. If aString does not contain four numbers, those numbers that were scanned are used, and 0 is used for the remaining values. If aString does not contain any numbers, this function returns an NSRect object with a rectangle whose origin is (0, 0) and width and height are both 0.

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSStringFromRect

  • Returns a string representation of a rectangle.

    Declaration

    Swift

    func NSStringFromRect(_ aRect: NSRect) -> String

    Objective-C

    NSString * NSStringFromRect ( NSRect aRect );

    Discussion

    Returns a string of the form “{{a, b}, {c, d}}”, where a, b, c, and d are the x and y coordinates and the width and height, respectively, of aRect.

    Availability

    Available in OS X v10.0 and later.

    See Also

    NSRectFromString

  • Returns an NSRect typecast from a CGRect.

    Declaration

    Swift

    func NSRectFromCGRect(_ cgrect: CGRect) -> NSRect

    Objective-C

    NSRect NSRectFromCGRect ( CGRect cgrect );

    Return Value

    An NSRect typecast from a CGRect.

    Availability

    Available in OS X v10.5 and later.

  • Returns a CGRect typecast from an NSRect.

    Declaration

    Swift

    func NSRectToCGRect(_ nsrect: NSRect) -> CGRect

    Objective-C

    CGRect NSRectToCGRect ( NSRect nsrect );

    Return Value

    A CGRect typecast from an NSRect.

    Availability

    Available in OS X v10.5 and later.

  • Calculates the union of two rectangles.

    Declaration

    Swift

    func NSUnionRect(_ aRect: NSRect, _ bRect: NSRect) -> NSRect

    Objective-C

    NSRect NSUnionRect ( NSRect aRect, NSRect bRect );

    Discussion

    Returns the smallest rectangle that completely encloses both aRect and bRect. If one of the rectangles has 0 (or negative) width or height, a copy of the other rectangle is returned; but if both have 0 (or negative) width or height, the returned rectangle has its origin at (0.0, 0.0) and has 0 width and height.

    Availability

    Available in OS X v10.0 and later.

  • Returns the width of the specified rectangle.

    Declaration

    Swift

    func NSWidth(_ aRect: NSRect) -> CGFloat

    Objective-C

    CGFloat NSWidth ( NSRect aRect );

    Return Value

    The width of aRect.

    Availability

    Available in OS X v10.0 and later.

Whether there’s an uncaught exception handler function, any uncaught exceptions cause the program to terminate, unless the exception is raised during the posting of a notification.

  • Casts an Objective-C pointer to a Core Foundation pointer and also transfers ownership to the caller.

    Declaration

    Swift

    func CFBridgingRetain(_ X: AnyObject?) -> AnyObject?

    Objective-C

    CFTypeRef CFBridgingRetain ( id X );

    Discussion

    You use this function to cast an Objective-C object as Core Foundation-style object and take ownership of the object so that you can manage its lifetime. You are responsible for subsequently releasing the object, as illustrated in this example:

    1. NSString *string = <#Get a string#>;
    2. CFStringRef cfString = (CFStringRef)CFBridgingRetain(string);
    3. // Use the CF string.
    4. CFRelease(cfString);

    Availability

    Available in OS X v10.7 and later.

  • Moves a non-Objective-C pointer to Objective-C and also transfers ownership to ARC.

    Declaration

    Objective-C

    id CFBridgingRelease ( CFTypeRef X );

    Discussion

    You use this function to cast a Core Foundation-style object as an Objective-C object and transfer ownership of the object to ARC such that you don’t have to release the object, as illustrated in this example:

    1. CFStringRef cfName = ABRecordCopyValue(person, kABPersonFirstNameProperty);
    2. NSString *name = (NSString *)CFBridgingRelease(cfName);

    Availability

    Available in OS X v10.7 and later.

    See Also

    CFBridgingRetain

  • Allocates a new block of memory.

    Declaration

    Swift

    func NSAllocateMemoryPages(_ bytes: Int) -> UnsafeMutablePointer<Void>

    Objective-C

    void * NSAllocateMemoryPages ( NSUInteger bytes );

    Discussion

    Allocates the integral number of pages whose total size is closest to, but not less than, byteCount. The allocated pages are guaranteed to be filled with zeros. If the allocation fails, raises NSInvalidArgumentException.

    Availability

    Available in OS X v10.0 and later.

  • Copies a block of memory.

    Declaration

    Swift

    func NSCopyMemoryPages(_ source: UnsafePointer<Void>, _ dest: UnsafeMutablePointer<Void>, _ bytes: Int)

    Objective-C

    void NSCopyMemoryPages ( const void *source, void *dest, NSUInteger bytes );

    Discussion

    Copies (or copies on write) byteCount bytes from source to destination.

    Availability

    Available in OS X v10.0 and later.

  • Deallocates the specified block of memory.

    Declaration

    Swift

    func NSDeallocateMemoryPages(_ ptr: UnsafeMutablePointer<Void>, _ bytes: Int)

    Objective-C

    void NSDeallocateMemoryPages ( void *ptr, NSUInteger bytes );

    Discussion

    This function deallocates memory that was allocated with NSAllocateMemoryPages.

    Availability

    Available in OS X v10.0 and later.

  • Returns the binary log of the page size.

    Declaration

    Swift

    func NSLogPageSize() -> Int

    Objective-C

    NSUInteger NSLogPageSize ( void );

    Return Value

    The binary log of the page size.

    Availability

    Available in OS X v10.0 and later.

  • Returns the number of bytes in a page.

    Declaration

    Swift

    func NSPageSize() -> Int

    Objective-C

    NSUInteger NSPageSize ( void );

    Return Value

    The number of bytes in a page.

    Availability

    Available in OS X v10.0 and later.

  • Returns information about the user’s system.

    Declaration

    Objective-C

    NSUInteger NSRealMemoryAvailable ( void );

    Return Value

    The number of bytes available in RAM.

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.8.

  • Returns the specified number of bytes rounded down to a multiple of the page size.

    Declaration

    Swift

    func NSRoundDownToMultipleOfPageSize(_ bytes: Int) -> Int

    Objective-C

    NSUInteger NSRoundDownToMultipleOfPageSize ( NSUInteger bytes );

    Return Value

    In bytes, the multiple of the page size that is closest to, but not greater than, byteCount (that is, the number of bytes rounded down to a multiple of the page size).

    Availability

    Available in OS X v10.0 and later.

  • Returns the specified number of bytes rounded up to a multiple of the page size.

    Declaration

    Swift

    func NSRoundUpToMultipleOfPageSize(_ bytes: Int) -> Int

    Objective-C

    NSUInteger NSRoundUpToMultipleOfPageSize ( NSUInteger bytes );

    Return Value

    In bytes, the multiple of the page size that is closest to, but not less than, byteCount (that is, the number of bytes rounded up to a multiple of the page size).

    Availability

    Available in OS X v10.0 and later.

  • Allocates collectable memory.

    Garbage collection is deprecated in OS X v10.8; instead,you should use AutomaticReference Counting—see Transitioning to ARC Release Notes.

    Declaration

    Objective-C

    void * NSAllocateCollectable ( NSUInteger size, NSUInteger options );

    Parameters

    size

    The number of bytes of memory to allocate.

    options

    0 or NSScannedOption: A value of 0 allocates non-scanned memory; a value of NSScannedOption allocates scanned memory.

    Return Value

    A pointer to the allocated memory, or NULL if the function is unable to allocate the requested memory.

    Availability

    Available in OS X v10.4 and later.

  • Reallocates collectable memory.

    Garbage collection is deprecated in OS X v10.8; instead,you should use AutomaticReference Counting—see Transitioning to ARC Release Notes.

    Declaration

    Objective-C

    void * NSReallocateCollectable ( void *ptr, NSUInteger size, NSUInteger options );

    Discussion

    Changes the size of the block of memory pointed to by ptr to size bytes. It may allocate new memory to replace the old, in which case it moves the contents of the old memory block to the new block, up to a maximum of size bytes.

    options can be 0 or NSScannedOption: A value of 0 allocates non-scanned memory; a value of NSScannedOption allocates scanned memory.

    This function returns NULL if it’s unable to allocate the requested memory.

    Availability

    Available in OS X v10.4 and later.

  • Makes a newly allocated Core Foundation object eligible for collection.

    Garbage collection is deprecated in OS X v10.8; instead,you should use AutomaticReference Counting—see Transitioning to ARC Release Notes.

    Declaration

    Objective-C

    id NSMakeCollectable ( CFTypeRef cf );

    Discussion

    This function is a wrapper for CFMakeCollectable, but its return type is id—avoiding the need for casting when using Cocoa objects.

    This function may be useful when returning Core Foundation objects in code that must support both garbage-collected and non-garbage-collected environments, as illustrated in the following example.

    1. - (CFDateRef)foo {
    2. CFDateRef aCFDate;
    3. // ...
    4. return [NSMakeCollectable(aCFDate) autorelease];
    5. }

    CFTypeRef style objects are garbage collected, yet only sometime after the last CFRelease is performed. Particularly for fully-bridged CFTypeRef objects such as CFStrings and collections (such as CFDictionary), you must call either CFMakeCollectable or the more type safe NSMakeCollectable, preferably right upon allocation.

    Availability

    Available in OS X v10.5 and later.

Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

  • Creates a new zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    NSZone * NSCreateZone ( NSUInteger startSize, NSUInteger granularity, BOOL canFree );

    Return Value

    A pointer to a new zone of startSize bytes, which will grow and shrink by granularity bytes. If canFree is 0, the allocator will never free memory, and malloc will be fast. Returns NULL if a new zone could not be created.

    Availability

    Available in OS X v10.0 and later.

  • Frees memory in a zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    void NSRecycleZone ( NSZone *zone );

    Discussion

    Frees zone after adding any of its pointers still in use to the default zone. (This strategy prevents retained objects from being inadvertently destroyed.)

    Availability

    Available in OS X v10.0 and later.

  • Sets the name of the specified zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    void NSSetZoneName ( NSZone *zone, NSString *name );

    Discussion

    Sets the name of zone to name, which can aid in debugging.

    Availability

    Available in OS X v10.0 and later.

  • Allocates memory in a zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    void * NSZoneCalloc ( NSZone *zone, NSUInteger numElems, NSUInteger byteSize );

    Discussion

    Allocates enough memory from zone for numElems elements, each with a size numBytes bytes, and returns a pointer to the allocated memory. The memory is initialized with zeros. This function returns NULL if it was unable to allocate the requested memory.

    Availability

    Available in OS X v10.0 and later.

  • Deallocates a block of memory in the specified zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    void NSZoneFree ( NSZone *zone, void *ptr );

    Discussion

    Returns memory to the zone from which it was allocated. The standard C function free does the same, but spends time finding which zone the memory belongs to.

    Availability

    Available in OS X v10.0 and later.

  • Gets the zone for a given block of memory.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    NSZone * NSZoneFromPointer ( void *ptr );

    Return Value

    The zone for the block of memory indicated by pointer, or NULL if the block was not allocated from a zone.

    Discussion

    pointer must be one that was returned by a prior call to an allocation function.

    Availability

    Available in OS X v10.0 and later.

  • Allocates memory in a zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    void * NSZoneMalloc ( NSZone *zone, NSUInteger size );

    Discussion

    Allocates size bytes in zone and returns a pointer to the allocated memory. This function returns NULL if it was unable to allocate the requested memory.

    Availability

    Available in OS X v10.0 and later.

  • Returns the name of the specified zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    NSString * NSZoneName ( NSZone *zone );

    Return Value

    A string containing the name associated with zone. If zone is nil, the default zone is used. If no name is associated with zone, the returned string is empty.

    Availability

    Available in OS X v10.0 and later.

  • Allocates memory in a zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    void * NSZoneRealloc ( NSZone *zone, void *ptr, NSUInteger size );

    Discussion

    Changes the size of the block of memory pointed to by ptr to size bytes. It may allocate new memory to replace the old, in which case it moves the contents of the old memory block to the new block, up to a maximum of size bytes. ptr may be NULL. This function returns NULL if it was unable to allocate the requested memory.

    Availability

    Available in OS X v10.0 and later.

  • Returns the default zone.

    Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.

    Declaration

    Objective-C

    NSZone * NSDefaultMallocZone ( void );

    Return Value

    The default zone, which is created automatically at startup.

    Discussion

    This zone is used by the standard C function malloc.

    Availability

    Available in OS X v10.0 and later.