Important: The information in this document is obsolete and should not be used for new development.
OTSetNBPZone
Set the zone part of an NBP entity structure.C INTERFACE
Boolean OTSetNBPZone(NBPEntity* entity, const char* zone);C++ INTERFACE
None. C++ applications use the C interface to this function.PARAMETERS
entity
- A pointer to the NBP entity structure in which you wish to set the zone.
zone
- A pointer to the zone portion of an NBP name string that you wish to store. Special characters must be quoted.
- function result
- This function returns
false
if thezone
parameter is longer than the maximum allowed for zone part of an NBP name (32 characters).DISCUSSION
TheOTSetNBPZone
function stores the NBP zone specified by thezone
parameter into the NBP entity structure indicated by theentity
parameter, deleting any previous zone stored there. To store the name and type parts of an NBP name in an NBP entity structure, use theOTSetNBPName
function and theOTSetNBPType
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".