RIL_GetEquipmentState (Compact 2013)

Article
11/04/2015

3/26/2014

This function retrieves the current equipment state.

Syntax

HRESULT RIL_GetEquipmentState(
  HRIL hRil,
    RILEQUIPMENTSTATE *pEqState
);

Parameters

[in] hRil
Handle to the RIL instance returned by RIL_Initialize.

[in,out] pEqstate
- Asynchronous
  [in]NULL.
- Synchronous
  [in] A pointer to a storage area
  [out] A pointer the equipment state to return.

Return Value

Asynchronous

Positive HRESULT values indicate success and are used as command identifications for matching the asynchronous call result. Negative HRESULT values indicate an error. HRESULT error values of E_XXX are defined in winerror.h. HRESULT error values of RIL_E_XXX are defined in Ril.h.

An asynchronous result callback of RIL_RESULT_OK indicates success. The lpData notification parameter points to a RILEQUIPMENTSTATE structure.

Synchronous

HRESULT value S_OK indicates success. Information is returned in the data structure pointed to by pEqstate.

HRESULT values of E_XXX indicate an error. Errors are defined in winerror.h.

Remarks

This function is asynchronous when the input value of pEqstate is NULL. The RIL proxy translates the RIL_GetEquipmentState function into IOCTL_RIL_GetEquipmentState when the RIL proxy calls RIL_IOControl.

This function is synchronous when pEqstate is not set to NULL. The RIL driver needs to support RIL_NOTIFY_EQUIPMENTSTATECHANGED for the synchronous function. In the registry key HKEY_LOCAL_MACHINE\Comm\Cellular\RIL\CapsNotificationImplParams, the value RIL_CAPS_NOTIFICATION_EQUIPMENTSTATE is used to determine if RIL_NOTIFY_EQUIPMENTSTATECHANGED is supported. If the RIL_CAPS_NOTIFICATION_EQUIPMENTSTATE value is not set to TRUE, RIL_E_SYNCHRONOUS_DATA_UNAVAILABLE is returned. You can use RIL_GetDevCaps (hRil, RIL_CAPSTYPE_NOTIFICATIONIMPLEMENTATION) to determine which notification values are set to TRUE.

Requirements

Header	ril.h
Library	Ril.lib

Share via