ADC Home > Reference Library > Reference > Networking > System Configuration Framework Reference

SCPreferencesPath

Includes:

Overview

The SCPreferencesPath API allows an application to load and store XML configuration data in a controlled manner and provide the necessary notifications to other applications that need to be aware of configuration changes.

The functions in the SCPreferencesPath API make certain assumptions about the layout of the preferences data. These functions view the data as a collection of dictionaries of key-value pairs and an associated path name. The root path ("/") identifies the top-level dictionary. Additional path components specify the keys for subdictionaries.

For example, the following dictionary can be accessed via two paths. The root ("/") path would return a dictionary with all keys and values. The path "/path1" would only return the dictionary with the "key3" and "key4" properties.

	
	<dict>
		<key>key1</key>
		<string>val1</string>
		<key>key2</key>
		<string>val2</string>
		<key>path1</key>
		<dict>
			<key>key3</key>
			<string>val3</string>
			<key>key4</key>
			<string>val4</string>
		</dict>
	</dict>

Each dictionary can also include the kSCResvLink ("__LINK__") key. The value associated with this key is interpreted as a link to another path. If this key is present, a call to the SCPreferencesPathGetValue function returns the dictionary specified by the link.

Functions

SCPreferencesPathCreateUniqueChild
SCPreferencesPathGetLink
SCPreferencesPathGetValue
SCPreferencesPathRemoveValue
SCPreferencesPathSetLink
SCPreferencesPathSetValue

SCPreferencesPathCreateUniqueChild

CFStringRef SCPreferencesPathCreateUniqueChild ( 
    SCPreferencesRef prefs, 
    CFStringRef prefix );

Parameters

prefs: The preferences session.
prefix: A string that represents the parent path.

Return Value

Returns a string representing the new (unique) child path; NULL if the specified path does not exist.

Discussion

Creates a new path component within the dictionary hierarchy.

SCPreferencesPathGetLink

CFStringRef SCPreferencesPathGetLink ( 
    SCPreferencesRef prefs, 
    CFStringRef path );

Parameters

prefs: The preferences session.
path: A string that represents the path to be returned.

Return Value

Returns the dictionary associated with the specified path; NULL if the path is not a link or does not exist.

Discussion

Returns the link (if one exists) associated with the specified path.

SCPreferencesPathGetValue

CFDictionaryRef SCPreferencesPathGetValue ( 
    SCPreferencesRef prefs, 
    CFStringRef path );

Parameters

prefs: The preferences session.
path: A string that represents the path to be returned.

Return Value

Returns the dictionary associated with the specified path; NULL if the path does not exist.

Discussion

Returns the dictionary associated with the specified path.

SCPreferencesPathRemoveValue

Boolean SCPreferencesPathRemoveValue ( 
    SCPreferencesRef prefs, 
    CFStringRef path );

Parameters

prefs: The preferences session.
path: A string that represents the path to be returned.

Return Value

Returns TRUE if successful; FALSE otherwise.

Discussion

Removes the data associated with the specified path.

SCPreferencesPathSetLink

Boolean SCPreferencesPathSetLink ( 
    SCPreferencesRef prefs, 
    CFStringRef path, 
    CFStringRef link );

Parameters

prefs: The preferences session.
path: A string that represents the path to be updated.
link: A string that represents the link to be stored at the specified path.

Return Value

Returns TRUE if successful; FALSE otherwise.

Discussion

Associates a link to a second dictionary at the specified path.

SCPreferencesPathSetValue

Boolean SCPreferencesPathSetValue ( 
    SCPreferencesRef prefs, 
    CFStringRef path, 
    CFDictionaryRef value );

Parameters

prefs: The preferences session.
path: A string that represents the path to be updated.
value: A dictionary that represents the data to be stored at the specified path.

Return Value

Returns TRUE if successful; FALSE otherwise.

Discussion

Associates a dictionary with the specified path.

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-03-11