RIL_GetRegistrationStatus (Compact 2013)
3/26/2014
This function retrieves the current phone registration status. This function is called periodically to determine whether the device has registered successfully and the nature of the network on which it is registered.
Syntax
HRESULT RIL_GetRegistrationStatus(
HRIL hRil,
DWORD * pdwRegStatus
);
Parameters
- hRil
[in] Handle to the RIL instance returned by RIL_Initialize.
pdwRegStatus
- Asynchronous
[in] NULL. - Synchronous
[in] Pointer to a storage area.
[out] Pointer to a Line Registration Constants.
- Asynchronous
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 parameter points to a line registration constant.
Synchronous
HRESULT value S_OK indicates success. Information is returned in the data structure pointed to by pdwRegStatus. HRESULT values of E_XXX indicate an error. Errors are defined in WinError.h.
Remarks
This function is asynchronous when the input value of pdwRegStatus is NULL. The RIL proxy translates the RIL_GetRegistrationStatus function into IOCTL_RIL_GetRegistrationStatus when the RIL proxy calls RIL_IOControl.
This function is synchronous when pdwRegStatus is not set to NULL. The RIL driver needs to support RIL_NOTIFY_REGSTATUSCHANGED for the synchronous function. In the registry key HKEY_LOCAL_MACHINE\Comm\Cellular\RIL\CapsNotificationImplParams, the value RIL_CAPS_NOTIFICATION_REGISTRATIONSTATUS is used to determine if registration status notification is supported. If the RIL_CAPS_NOTIFICATION_REGISTRATIONSTATUS 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 |