Otcfgdeleteentity, Otcfgduplicateentity – Apple Network Setup User Manual

Page 78

Advertising
background image

C H A P T E R 3

Network Setup Reference

78

Network Setup Functions

OTCfgDeleteEntity

3

Deletes the specified entity.

OSStatus OTCfgDeleteEntity (CfgDatabaseRef dbRef,

const CfgEntityRef* entityRef);

dbRef

On input, a value of type

CfgDatabaseRef

(page 98) that

represents a database session previously opened by calling

OTCfgOpenDatabase

(page 58).

entityRef

On input, a pointer to a value of type

CfgEntityRef

(page 99)

representing the entity that is to be deleted. If

entityRef

represents an entity that does not reside in an area that is open
for writing,

OTCfgDeleteEntity

returns the error

kCfgErrAreaNotOpen

or

kCfgErrLocked

. If the entity represented

by

entityRef

does not exist,

OTCfgDeleteEntry

returns the error

kCfgErrEntityNotFound

.

function result A value of

noErr

indicates that

OTCfgDeleteEntity

returned

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

DISCUSSION

The

OTCfgDeleteEntity

function deletes the specified entity.

OTCfgDuplicateEntity

3

Copies the contents of one entity to another entity.

OSStatus OTCfgDuplicateEntity (CfgDatabaseRef dbRef,

const CfgEntityRef* entityRef,

const CfgEntityRef* newEntityRef);

dbRef

On input, a value of type

CfgDatabaseRef

(page 98) that

represents a database session previously opened by calling

OTCfgOpenDatabase

(page 58).

Advertising