Legacy Document

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 24 - Mappers Reference / Functions

Registering and Deleting Names /

OTDeleteNameByID

Removes a previously registered name as specified by its name ID.

C INTERFACE

OSStatus OTDeleteNameByID (MapperRef ref, 
                     OTNameID nameID);

C++ INTERFACE

TMapper::DeleteName(OTNameID nameID);

PARAMETERS

ref

A mapper reference.

id

The name ID, a 32-bit value specifying a number that identifies the registered name.

function result

An error code. See Appendix B for more information.

DISCUSSION

If the mapper protocol defined using the config parameter to the OTOpenMapper or OTAsyncOpenMapper functions supports dynamic name and address registration, you can use the OTDeleteNameByID function to delete a registered name.

If the mapper is in synchronous mode, the function does not return until the operation is complete. If the mapper is in asynchronous mode, the OTDeleteNameByID function returns immediately. When the operation completes execution, the mapper provider calls the notifier function, passing T_DELNAMECOMPLETE for the code parameter, and the nameID parameter in the cookie parameter. For more information on notifier functions and event codes see "Using Notifier Functions" and "Event Codes".

The name ID that you delete using the OTDeleteNameByID function is returned in the reply parameter to the OTRegisterName function.