Otcfgdeletearea, Managing entities, Managing entities 3 – Apple Network Setup User Manual

Page 72

Advertising
background image

C H A P T E R 3

Network Setup Reference

72

Network Setup Functions

OTCfgDeleteArea

3

Deletes an area in the Network Setup database.

OSStatus OTCfgDeleteArea (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 value of type

CfgAreaID

(page 98) that identifies the

area that is to be deleted. If the area specified by

areaID

does not

exist,

OTCfgDeleteArea

returns

kCfgErrAreaNotFound

.

function result A value of

noErr

indicates that

OTCfgDeleteArea

returned

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

DISCUSSION

The

OTCfgDeleteArea

function removes the specified area from the database.

IMPORTANT

The

OTCfgDeleteArea

function has almost no purpose in the

version of Network Setup described by this document.

Managing Entities

3

Use the following functions to create, modify, and delete entities within an area:

OTCfgGetEntitiesCount

(page 73) obtains the number of entities in an area.

OTCfgGetEntitiesList

(page 74) obtains a list of entities in an area.

OTCfgIsSameEntityRef

(page 76) determines whether two entity references are

the same.

OTCfgCreateEntity

(page 76) creates an entity in an area.

OTCfgDeleteEntity

(page 78) deletes an entity from an area.

Advertising