Important: The information in this document is obsolete and should not be used for new development.
OTSetNBPName
Set the name part of an NBP entity structure.C INTERFACE
Boolean OTSetNBPName(NBPEntity* entity, const char* name);C++ INTERFACE
None. C++ applications use the C interface to this function.PARAMETERS
nbpEntity
- A pointer to the NBP entity structure in which you wish to set the name.
name
- A pointer to the name portion of an NBP name string that you wish to store. Special characters must be quoted.
- function result
- See Discussion.
DISCUSSION
TheOTSetNBPName
function stores the NBP name specified by thename
parameter into the NBP entity structure indicated by theentity
parameter, deleting any previous name stored there. This function returnsfalse
if thename
parameter is longer than the maximum allowed for a name part of an NBP name (32 characters).To store the type and zone parts of an NBP name in an NBP entity structure, use the
OTSetNBPType
function and theOTSetNBPZone
function, respectively.To extract the name, type, and zone parts of an NBP name in an NBP entity structure, use the
OTExtractNBPName
function, theOTExtractNBPType
function, and theOTExtractNBPZone
function, respectively.SPECIAL CONSIDERATIONS
Backslashes in front of special characters will be removed. The functionOTSetAddressFromNBPEntity
will automatically insert them for mapper calls.SEE ALSO
"The NBP Address Structure".