Developer

API Reference

IBTImagePullInitiator_RetrieveDescriptor()

Brew Release
Brew MP 1.0.2
See Also
IBTImagePullInitiator_GetImagesList
Description
Retrieves the descriptor string.
This API can be called when the nDescriptorLen field of an event indicates a descriptor is present. Depending on the event, this could be an image descriptor or an image handles descriptor.
Parameters
  • _me
    [in]:
    the object descriptor [i/o] : destination for descriptor string
  • descriptorLen
    [in]:
    number of characters descriptor buffer can hold
  • descriptorLenReq
    [out]:
    number of characters descriptor must be able to hold
    Return
  • AEE_SUCCESS
    []:
    descriptor string copied
  • AEE_EBUFFERTOOSMALL
    []:
    descriptor buffer not large enough to hold string
  • AEE_ENOSUCH
    []:
    no descriptor received
Prototype
   AEEResult IBTImagePullInitiator_RetrieveDescriptor(
                IBTBIPInitiator* _me,
                char*            descriptor, 
                int              descriptorLen, 
                int*             descriptorLenReq);
Side Effect
None
Comment
None
  • Follow