Otcfggetcurrentarea – Apple Network Setup User Manual

Page 60

Advertising
background image

C H A P T E R 3

Network Setup Reference

60

Network Setup Functions

IMPORTANT

Areas other than the default area (also known as the
current area) do not affect any network setting, so many of
the area manipulation functions described in this section
are not commonly used. You rarely need to call

OTCfgGetAreaName

,

OTCfgSetAreaName

,

OTCfgGetAreasCount

,

OTCfgGetAreasList

,

OTCfgCreateArea

,

OTCfgDuplicateArea

,

or

OTCfgDeleteArea

.

OTCfgGetCurrentArea

3

Obtains the default area.

OSStatus OTCfgGetCurrentArea (CfgDatabaseRef dbRef,

CfgAreaID* areaID);

dbRef

On input, a value of type

CfgDatabaseRef

(page 98) that

represents a database session previously opened by calling

OTCfgOpenDatabase

(page 58).

areaID

On input, a pointer to a value of type

CfgAreaID

(page 98). On

output,

areaID

points to the area ID of the current area.

function result A value of

noErr

indicates that

OTCfgGetCurrentArea

returned

successfully. For a list of other possible result codes, see “Result
Codes” (page 110).

DISCUSSION

The

OTCfgGetCurrentArea

function obtains the area ID of the default area. The

default area is sometimes referred to as the current area.

Advertising