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

Developer

API Reference

IUSBFUNCTION_GETENDPOINTINFO()

Brew Release
Brew MP 1.0.2
See Also
IUSBFunction_GetNumberOfEndpointPort1s IUSBDevice_ConstructEndpoint IUSBFunction_SetEndpointPort1
Description
Used to determine the specification of an IUSBEndpointPort1 that will represent an IN and/or an OUT endpoint(s). The caller of this API should create the endpoint with IUSBDevice_ConstructEndpoint and then return the IUSBEndpointPort1 to the IUSBFunction with a call to IUSBFunction_SetEndpointPort1. nEndpoint should be between zero and the pnEndpoints value - 1 retrieved with IUSBFunction_GetNumberofEndpointPort1s.
Params
pMe
[in]:
Pointer to an IUSBFunction object
nEndpoint
[in]:
The ID of the endpoint pair that information is being retrieved for.
pInEPInfo
[out]:
Pointer to a AEEUSBEndpointInfo structure that will contain the information for the IN endpoint.
pOutEPInfo
[out]:
Pointer to a AEEUSBEndpointInfo structure that will contain the information for the OUT endpoint.
pnInterface
[out]:
Pointer to an integer that indicates the interface that the endpoint is active on.
pnAltSetting
[out]:
Pointer to an integer that indicates the alternate interface setting that the endpoint is active on.
pbSupportsFullSpeed
[in]:
Pointer to a boolean that indicates that the endpoint is supported when the device is connected in full speed.
pbSupportsHighSpeed
[in]:
Pointer to a boolean that indicates that the endpoint is supported when the device is connected in high speed.
Interface
Prototype
  •    AEEResult IUSBFunction_GetEndpointInfo(IUSBFunction* pMe, 
                                              int nEndpoint,
                                              AEEUSBEndpointInfo* pInEPInfo, 
                                              AEEUSBEndpointInfo* pOutEPInfo, 
                                              int* pnInterface,
                                              int* pnAltSetting,
                                              boolean *pbSupportsFullSpeed,
                                              boolean *pbSupportsHighSpeed)
    
Return

  • AEE_SUCCESS : if the operation was successful. AEE_EBADPARM : if the nEndpoint parameter is invalid
    Another appropriate error code if operation was not successful
Side Effect
  • None
Comments
None.