CFPreferencesCopyValue

Header: CFPreferences.h Carbon status: Supported

Obtains a preference value for the specified domain.

CFPropertyListRef CFPreferencesCopyValue (
    CFStringRef key, 
    CFStringRef appName, 
    CFStringRef user, 
    CFStringRef host
);
Parameter descriptions
key

Preferences key for the value you wish to obtain.

appName

The ID of the application whose preferences you wish to search.

user

The username whose preferences you wish to search.

host

The hostname whose preferences you wish to search.

function result

The preference data for the specified domain. The data is returned as a Core Foundation Property List data type. If the no value was located, NULL is returned. You must release the returned value.

DISCUSSION

This function is the primitive get mechanism for the higher level preference function CFPreferencesCopyAppValue Unlike the high-level function, CFPreferencesCopyValue searches only the exact domain specified. Do not use this function directly unless you have a need. All arguments must be non-NULL. Do not use arbitrary user and host names, instead pass the pre-defined domain qualifier constants.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


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