CFNumberGetValue

Header: CFNumber.h Carbon status: Supported

Obtains the value of the specified CFNumber object.

Boolean CFNumberGetValue (
    CFNumberRef number, 
    CFNumberType numType, 
    void *valuePtr
);
Parameter descriptions
number

The CFNumber object whose value you wish to obtain.

numType

A constant indicating the data type you wish returned to you. See CFNumber Type Flags for a list of possible values.

valuePtr

A pointer to the storage that will receive the CFNumber object's value.

function result

TRUE if the operation was successful. FALSE if an error occurred.

DISCUSSION

If a conversion is necessary, the conversion rules follow human expectation and not C promotion and truncation rules. If the conversion is lossy, or the value is out of range, FALSE is returned.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)