Important: The information in this document is obsolete and should not be used for new development.
OTSetAddressFromNBPString
Copies an NBP name string into an NBP address buffer.C INTERFACE
size_t OTSetAddressFromNBPString(UInt8* addrBuf, const char* nbpName, SInt32C++ INTERFACE
None. C++ applications use the C interface to this function.PARAMETERS
addrBuf
- A pointer to the NBP address buffer in which to store the NBP name string.
nbpName
- A pointer to the NBP name string you wish to copy into the buffer.
len
- The number of characters to copy. Specify -1 to copy all the characters in the string up to a null terminator. Use -1 to copy the entire string.
- function result
- The number of bytes actually copied.
DISCUSSION
TheOTSetAddressFromNBPString
function copies the string indicated by thenbpName
parameter into the buffer indicated by theaddrBuf
parameter. Thelen
parameter indicates the number of characters to copy. A value of -1 copies the entirenbpName
string.To copy the contents of an NBP entity into an NBP address structure, use the
OTSetAddressFromNBPEntity
function.The
nbpName
parameter must have a "\" in front of all the special characters.SEE ALSO
"The NBP Address Structure".