Managing preferences, Managing preferences 3 – Apple Network Setup User Manual

Page 83

Advertising
background image

C H A P T E R 3

Network Setup Reference

Network Setup Functions

83

entityRef

On input, a pointer to a value of type

CfgEntityRef

(page 99)

that represents the entity reference whose area is to be changed.
To obtain the entity reference for an entity, call

OTCfgGetEntitiesList

(page 74) or use the entity reference

returned by a Network Setup function that creates an entity.

newAreaID

On input, a value of type

CfgAreaID

(page 98) that specifies the

new area ID for the specified entity.

function result None.

DISCUSSION

The

OTCfgChangeEntityArea

function changes the area ID of the specified entity.

This function does not actually move the entity. Instead, it changes the entity
reference to point to the same entity in the area specified by

newAreaID

.

Managing Preferences

3

Use the following functions to manage preferences, which are stored in an
entity:

OTCfgOpenPrefs

(page 84) opens an entity so that its preferences can be

accessed.

OTCfgClosePrefs

(page 85) closes an entity.

OTCfgGetPrefsSize

(page 85) gets the size of a preference.

OTCfgGetPrefs

(page 86) gets the value of a preference.

OTCfgSetPrefs

(page 87) sets the value of a preference.

OTCfgGetPrefsTOCCount

(page 88) gets the number of preferences in an entity.

OTCfgGetPrefsTOC

(page 89) gets a list of a preferences in an entity.

OTCfgGetDefault

(page 90) gets the default value for a preference.

OTCfgDeletePrefs

(page 90) deletes a preference from an entity.

OTCfgGetTemplate

(page 91) gets a preference’s template.

Advertising