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

Developer

API Reference

IQOSBUNDLE_GETERROR()

Brew Release
Brew MP 1.0.2
See Also
Description
This function returns an AEEQoSSessionError that can be used by clients in order to receive information on the reason for the failure.
Clients should call this function after a QoS Bundle operation (IQoSBundle_Open(), IQoSBundle_OpenEx(), IQoSBundle_Close(), IQoSBundle_GoActive(), IQoSBundle_Deactivate()) returns AEE_NET_EQOS_SESSION_INVALID_OPT. In this case the AEEQoSSessionError will indicate which QoS Session in the bundle caused the failure and what was the type of the error. In case the returned error code is AEE_QOS_SESSION_ERR_CODE_INVAL_SPEC the client can refer to the appropriate QoS Session in the QoS Sessions list (according to the AEEQoSSessionError index value) and call IQoSSession_GetError() to receive more information on the QoS Specification error.
If an AEEQoSSessionError member is not applicable, its index will be marked as AEE_QOS_SESSION_ERR_INDEX_UNSPEC.

Params
po
[]:
the interface pointer
pError
[out]:
returns a QoS Session error.
Interface
Prototype
  •    int IQoSSession_GetError(IQoSBundle* po, AEEQoSSessionError* pError);
          
Return
  • AEE_SUCCESS: error was successfully retrieved into pError. AEE_EBADPARM: the provided pError parameter is invalid.
Side Effect
  • None.
Comments
None.