The SimConnect_RequestReservedKey function is used to request a specific keyboard TAB-key combination applies only to this client.

NOTE: The current status of this function is NO ERROR, NO RESPONSE.



HRESULT SimConnect_RequestReservedKey(
    HANDLE  hSimConnect,
    const char*  szKeyChoice1,
    const char*  szKeyChoice2 = "",
    const char*  szKeyChoice3 = ""



Parameter Description Type
hSimConnect Handle to a SimConnect object. Integer
EventID Specifies the client defined event ID. Integer
szKeyChoice1 Null-terminated string containing the first key choice. Refer to the list below for all the choices that can be entered for these three parameters.


szKeyChoice2 Null-terminated string containing the second key choice. String
szKeyChoice3 Null-terminated string containing the third key choice. String


The you can find a list of all the available key strings that can be used in the szKeyChoiceN parameter here:



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.




A successful call to this function will result in a SIMCONNECT_RECV_RESERVED_KEY structure being returned, with the key that has been assigned to this client. The first of the three that can be assigned will be the choice, unless all three are already taken, in which case a null string will be returned.


The szKeyChoice parameters should be a single character (such as "A"), which is requesting that the key combination TAB-A is reserved for this client. All reserved keys are TAB-key combinations.



See Also