CFPreferencesGetAppIntegerValue

Header: CFPreferences.h Carbon status: Under Evaluation

Convenience function that directly obtains an integer preference value for the specified key.

CFIndex CFPreferencesGetAppIntegerValue (
    CFStringRef key, 
    CFStringRef applicationID, 
    Boolean *keyExistsAndHasValidFormat
);
Parameter descriptions
key

The preference key whose value you wish to obtain. The key must specify a preference whose value is of type int.

applicationID

The identifier of the application whose preferences you wish to search, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication.

keyExistsAndHasValidFormat

On return, indicates whether the preference value for the specified key was located and found to be of type int.

function result

The preference data for the specified key and application. If no value was located, 0 is returned.

AVAILABILITY

Under evaluation for Carbon. Available in Carbon 1.1 and later when CarbonLib 1.1CarbonLib 1.1 or later is present.


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)