API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IOBEXHEADER_GETSTRING()

Brew Release
Brew MP 1.0.2
See Also
Description
An application can call this function to retrieve an OBEX header, which is a Unicode (USC2) string.
Params
po
[in]:
Pointer to the IOBEXHeader object.
headerId
[in]:
Header Id of the header being retrieved.
pwSeq
[out]:
Pointer to the buffer to store the string.
nwSeqLen
[in]:
Length of the buffer allocated to retrieve the string.The length includes the NULL terminator.
pnwSeqLenReq
[out]:
If return value is AEE_EBUFFERTOOSMALL, this location will contain the size of the buffer that is required to return the entire string. For example, if the string is "xyz.txt", then *pnwSeqLenReq will contain 8.
Interface
Prototype
  •    int IOBEXHeader_GetString(IOBEXHeader       *po,
                                 AEEOBEXHeaderID   headerId,
                                 AECHAR            *pwSeq,
                                 int               nwSeqLen,
                                 int               *pnwSeqLenReq)
    
Return
  • AEE_SUCCESS : The header was returned successfully. AEE_EBADPARM : Bad parameters. AEE_EBUFFERTOOSMALL : Buffer allocated for the string is insufficient. AEE_ENOSUCH : No header found with matching header ID.
Side Effect
  • None.
Comments
None.