Apple Network Setup - Manual (Page 66)

C H A P T E R 3
Network Setup Reference
66 Network Setup Functions
function result A Boolean value that is TRUE if the area IDs are the same and
FALSE if the area IDs are different.
DISCUSSION
The OTCfgIsSameAreaID function determines whether two area IDs represent to
the same area.
OTCfgGetAreaName 3
Obtains the user-visible name of an area.
OSStatus OTCfgGetAreaName (CfgDatabaseRef dbRef,
CfgAreaID areaID,
Str255 areaName);
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 value of type CfgAreaID (page 98) that identifies the
area whose name is to be obtained. If the area specified by
areaID does not exist, OTCfgGetAreaName returns
kCfgErrAreaNotFound .
areaName On input, a value of type Str255 . On output, areaName contains
the user-visible name of the area specified by areaID .
function result A value of noErr indicates that OTCfgGetAreaName returned
successfully. For a list of other possible result codes, see “Result
Codes” (page 110).
DISCUSSION
The OTCfgGetAreaName function gets the user-visible name of the specified area.
Note
The OTCfgGetAreaName function is available in Network
Setup version 1.0.1 and later. ◆