Developer

API Reference

IBTBIPResponder_GetDescriptor()

Brew Release
Brew MP 1.0.2
See Also
IBTBIPResponder_GetRequestData()
Description
Retrieves the descriptor string describing the image or attachment.
This API can be called when the nDescriptorLen field in the request indicates the presence of a descriptor.
Parameters
  • _me
    [in]:
    the object
  • desc
    [out]:
    destination for descriptor string
  • descLen
    [in]:
    number of characters desc can hold
  • descLenReq
    [out]:
    number of characters desc must be able to hold
    Return
  • AEE_SUCCESS
    []:
    descriptor string successfully retrieved
  • AEE_EBADPARM
    []:
    invalid input parameters
  • AEE_EBUFFERTOOSMALL
    []:
    desc not large enough to hold descriptor string
  • AEE_ENOSUCH
    []:
    descriptor string not available
Prototype
   AEEResult IBTBIPResponder_GetDescriptor(IBTBIPResponder* _me, 
                                           char*            desc,
                                           int              descLen, 
                                           int*             descLenReq);
Side Effect
None
Comment
None
  • Follow