RIL_GetGPRSContextList (Compact 2013)

  • Article

3/26/2014

This function retrieves a list of GPRS contexts.

Syntax

HRESULT RIL_GetGPRSContextList(
  HRIL hRil,
    RILGPRSCONTEXT pGPRSContext,
    DWORD pdwDataSize
);

Parameters

  • pGRPSContext

    • Asynchronous
      [in] NULL.
    • Synchronous
      [in] Pointer to a storage area
      [out] Pointer to the returned RILGPRSCONTEXT.

  • pdwDataSize
    [in] Pointer to the length of pGPRSContext.

    [out] Pointer to the returned data size of pGPRSContext.

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. An asynchronous result of RIL_RESULT_OK indicates success. The lpData notification parameter points to a RILGPRSCONTEXT structure.

Synchronous

HRESULT value S_OK indicates success. Information is returned in the data structure pointed to by pGRPSContext. HRESULT values of E_XXX indicate an error. Errors are defined in winerror.h.

If the return data is bigger than the input value of pdwDataSize, ERROR_INSUFFICIENT_BUFFER is returned as the synchronous function result.

Remarks

This function is asynchronous when the input value of pGRPSContext is NULL. The RIL proxy translates the RIL_GetGPRSContextList function into IOCTL_RIL_GetGPRSContextList when the RIL proxy calls RIL_IOControl.

This function is synchronous when pGRPSContext is not set to NULL. The RIL driver needs to support RIL_NOTIFY_GPRSCONTEXT for the synchronous function. In the registry key, HKEY_LOCAL_MACHINE\Comm\Cellular\RIL\CapsNotificationImplParams, the value RIL_CAPS_NOTIFICATION_GPRSCONTEXTLIST is used to determine if RIL_NOTIFY_GPRSCONTEXT is supported. If the RIL_CAPS_NOTIFICATION_GPRSCONTEXTLIST 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

See Also

Reference

RIL Functions