Developer

API Reference

IBTBIPResponder_GetName()

Brew Release
Brew MP 1.0.2
See Also
IBTBIPResponder_GetRequestData()
Description
Retrieves the object name, be it image name or attachment name, depending on the imaging request.
This API can be called when the nNameLen field in the request indicates the presence of a name.
Parameters
  • _me
    [in]:
    the object
  • name
    [out]:
    destination name of image/attachment
  • nameLen
    [in]:
    number of characters name can hold
  • nameLenReq
    [out]:
    number of characters name must be able to hold
    Return
  • AEE_SUCCESS
    []:
    object name is successfully retrieved
  • AEE_EBADPARM
    []:
    invalid input parameters
  • AEE_EBUFFERTOOSMALL
    []:
    szName not large enough to hold name
  • AEE_ENOSUCH
    []:
    name not available
Prototype
   AEEResult IBTBIPResponder_GetName(IBTBIPResponder* _me, 
                                     char*            name,
                                     int              nameLen, 
                                     int*             nameLenReq);
Side Effect
None
Comment
None
  • Follow