Instance Method

getObjectValue:forString:range:error:

Returns by reference a cell-content object after creating it from a range of characters in a given string.

Declaration

- (BOOL)getObjectValue:(out id  _Nullable *)obj forString:(NSString *)string range:(inout NSRange *)rangep error:(out NSError * _Nullable *)error;

Parameters

anObject

On return, contains an instance of NSDecimalNumber or NSNumber based on the current value of the generatesDecimalNumbers property. Returns nil by reference if conversion failed.

aString

A string object with the range of characters specified in rangep that is used to create anObject.

rangep

A range of characters in aString. On return, contains the actual range of characters used to create the object.

error

If an error occurs, upon return contains an NSError object in the NSCocoaErrorDomain with code NSFormattingError that explains why the conversion failed. If you pass in nil for error you are indicating that you are not interested in error information.

Return Value

YES if the conversion from string to cell-content object was successful, otherwise NO.

Discussion

If a string contains any characters other than numerical digits or locale-appropriate group or decimal separators, parsing will fail.

Any leading or trailing space separator characters in a string are ignored. For example, the strings “ 5”, “5 ”, and “5” all produce the number 5.

If there is an error, this method calls control:didFailToFormatString:errorDescription: on the delegate.

See Also

Converting Between Numbers and Strings

- numberFromString:

Returns an NSNumber object created by parsing a given string.

- stringFromNumber:

Returns a string containing the formatted value of the provided number object.

+ localizedStringFromNumber:numberStyle:

Returns a localized number string with the specified style.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software