SimConnect_UnsubscribeToCommBusEvent

The SimConnect_UnsubscribeToCommBusEvent function is used to unsubscribe the client from a communication (CommBus) event.

 

Syntax
HRESULT SimConnect_UnsubscribeToCommBusEvent(
    HANDLE hSimConnect,
    SIMCONNECT_CLIENT_EVENT_ID EventID
    );

 

Parameters
Parameter Description Type
hSimConnect Handle to a SimConnect object. Integer
EventID Specifies the ID of the client event. Integer

 

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

  

Syntax
void SimConnect::UnsubscribeToCommBusEvent(
    Enum EventID
    );

 

Parameters
Parameter Description Type
EventID

The ID with which the event has been registered on the client.

Enum

 

Return Values
N/A (use a try/catch to test for errors).

 

 

Remarks

N/A

 

0/255