Share via


RIL Functions

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

RIL functions can be asynchronous or synchronous. Most of the RIL functions are asynchronous. For both asynchronous and synchronous RIL functions, an immediate asynchronous returned result, HRESULT, indicates success or failure of the function call.

For asynchronous functions, positive HRESULT values indicate success and are used as command identifications for matching the asynchronous callback. The asynchronous result callback returns the final result in a buffer. Valid command identifications are in the range 0x00000001 to 0x7fffffff. Zero is not a valid return value for asynchronous calls. Negative HRESULT values indicate an error. HRESULT error values of E_XXX are defined in winerror.h file. HRESULT error values of RIL_E_XXX are defined in Ril.h.

For synchronous functions, an HRESULT value of S_OK indicates success. An asynchronous result callback is not called. If a synchronous RIL function needs a final result, a pointer to a data structure is passed in the RIL function and the final result is put in the data structure. For synchronous functions, HRESULT values of E_XXX indicate an error. Errors are defined in winerror.h file.

The following table shows the RIL functions with a description of the purpose of each.

Function Description

RIL_AddCallForwarding

This function adds a call forwarding rule.

RIL_AddPreferredOperator

This function adds a specified operator to the list of preferred operators.

RIL_Answer

This function is implemented by a RIL driver. It is responsible for answering the currently offering call.

RIL_CancelSupServiceDataSession

This function cancels the current supplementary service session.

RIL_ChangeCallBarringPassword

This function changes the password for the specified type of call barring.

RIL_ChangeLockingPassword

This function changes the locking password for the specified facility.

RIL_ClearCCBSRegistration

This function clears the registration for a completion of the call to busy subscriber (CCBS) index.

RIL_Deinitialize

This function deinitializes RIL. This function is synchronous.

RIL_DeleteGPRSContext

This function deletes a particular GPRS context.

RIL_DeleteMinimumQualityOfService

This function deletes the minimum quality of service profile for a context.

RIL_DeleteMsg

This function deletes a message from the current storage location.

RIL_DeletePhonebookEntry

This function deletes a phonebook entry from the current storage location.

RIL_DeleteRequestedQualityOfService

This function deletes the requested quality of service profile for a context.

RIL_DevSpecific

This function is used by an OEM to provide custom calls into the RIL driver.

RIL_Dial

This function is responsible for dialing voice and data calls.

RIL_DisableNotifications

This function disables classes of notifications for a client. This function is synchronous.

RIL_EnableNotifications

This function enables additional classes of notifications for a client. This function is synchronous.

RIL_EnterGPRSDataMode

This function enters into a GPRS data state.

RIL_FetchSimToolkitCmd

This function fetches a SIM Toolkit command from the SIM.

RIL_GetAllOperatorsList

This function retrieves the built-in list of all known operators.

RIL_GetATR

This function gets the Answer To Reset (ATR) string from the SIM.

RIL_GetAudioDevices

This function retrieves the current transmit and receive audio devices.

RIL_GetAudioGain

This function retrieves audio gain information.

RIL_GetAudioMuting

This function is implemented by a RIL driver. It is responsible for querying the mute status of the radio.

RIL_GetBearerServiceOptions

This function retrieves the current data bearer service options.

RIL_GetCallBarringStatus

This function retrieves the status of the specified type of call barring.

RIL_GetCallerIdSettings

This function retrieves the current caller ID settings.

RIL_GetCallForwardingSettings

This function retrieves current call forwarding rules.

RIL_GetCallWaitingSettings

This function retrieves information classes that call waiting is currently enabled for.

RIL_GetCCBSStatus

This function retrieves the status for a Completion of Call to Busy Subscriber (CCBS) index.

RIL_GetCellBroadcastMsgConfig

This function retrieves the cell broadcast messaging configuration.

RIL_GetCellTowerInfo

This function retrieves information about the cell tower currently used by the phone.

RIL_GetClosedGroupSettings

This function retrieves the current closed user group settings.

RIL_GetCurrentAddressId

This function retrieves the current or default address identification for devices that support multiple device addresses.

RIL_GetCurrentOperator

This function retrieves the operator the device is currently registered with.

RIL_GetCurrentPrivacyStatus

This function retrieves the current voice privacy status.

RIL_GetCurrentRoamingStatus

This function retrieves the current roaming status.

RIL_GetCurrentSystemType

This function retrieves the current system types.

RIL_GetDataCompression

This function retrieves data compression options.

RIL_GetDevCaps

This function is responsible for retrieving specific device capabilities.

RIL_GetDialedIdSettings

This function retrieves the current settings for the dialed ID.

RIL_GetDriverVersion

This function retrieves the driver version information. This function is synchronous.

RIL_GetEquipmentInfo

This function retrieves manufacturer equipment information.

RIL_GetEquipmentState

This function retrieves the current equipment state.

RIL_GetErrorCorrection

This function retrieves error correction options.

RIL_GetGPRSAddress

This function gets the PDP address for a particular context.

RIL_GetGPRSAttached

This function gets the GPRS attach state.

RIL_GetGPRSClass

This function retrieves the current GPRS class.

RIL_GetGPRSContextActivatedList

This function gets the GPRS activation state for all contexts.

RIL_GetGPRSContextList

This function retrieves a list of GPRS contexts.

RIL_GetGPRSRegistrationStatus

This function retrieves the current phone GPRS registration status.

RIL_GetHideConnectedIdSettings

This function retrieves the current settings for the Hide Connected ID option.

RIL_GetHideIdSettings

This function retrieves the current settings for the Hide ID option.

RIL_GetHSCSDCallSettings

This function retrieves High Speed Circuit Switched Data options.

RIL_GetHSCSDOptions

This function retrieves High Speed Circuit Switched Data (HSCSD) options.

RIL_GetLockingStatus

This function retrieves locking status for the specified facility.

RIL_GetMinimumQualityOfServiceList

This function gets the minimum quality of service profile for all contexts.

RIL_GetMOSMSService

This function retrieves the preferred Short Message Serve (SMS) service option for mobile-originated messages.

RIL_GetMsgConfig

This function gets the current messaging configuration.

RIL_GetMsgServiceOptions

This function gets the current messaging service options.

RIL_GetOperatorList

This function retrieves the list of available operators.

RIL_GetPacketByteCount

This function retrieves the cumulative count of data bytes transferred by the radio.

RIL_GetPhonebookOptions

This function retrieves the current phonebook options.

RIL_GetPhoneLockedState

This function retrieves the current locked state of the phone.

RIL_GetPreferredOperatorList

This function retrieves the list of preferred operators.

RIL_GetRadioPresence

This function determines if the radio is present. This function is synchronous.

RIL_GetRegistrationStatus

This function retrieves the current phone registration status.

RIL_GetRequestedQualityOfServiceList

This function gets the requested quality of service profile for all contexts.

RIL_GetRLPOptions

This function retrieves the current radio link protocol options.

RIL_GetRoamingMode

This function retrieves the CDMA roaming mode.

RIL_GetSerialPortHandle

This function retrieves a serial port handle to be used for data communications. This function is synchronous.

RIL_GetSerialPortHandleFromContextID

This function retrieves a serial port handle from the PDP context to be used for data communications. This function is synchronous.

RIL_GetSerialPortStatistics

This function retrieves a serial port handle statistics. This function is synchronous.

RIL_GetSignalQuality

This function retrieves information about the received signal quality.

RIL_GetSimRecordStatus

This function retrieves the status of the Subscriber Identity Module (SIM) record.

RIL_GetSimToolkitProfile

This function retrieves the SIM Toolkit terminal profile.

RIL_GetSubscriberNumbers

This function retrieves information about all subscriber lines available for use.

RIL_GetSystemTime

This function retrieves the system time from the network.

RIL_GetUserIdentity

This function retrieves the International Mobile Subscriber Identity (IMSI) of the phone user.

RIL_GPRSAnswer

This function answers an incoming GPRS activation request.

RIL_Hangup

This function is responsible for hanging up all calls.

RIL_InitializeEmergency

Initializes RIL for use by an emergency call module. This function is synchronous.

> [!NOTE] > This function is deprecated.

RIL_Initialize

This function initializes RIL for use by a client. This function is synchronous.

RIL_LogEventToRadio

This function sends a string to the radio for logging purposes.

RIL_ManageCalls

This function modifies the state of active, held, and waiting calls.

RIL_NDIS_ReceivePacketDone

This function informs the RIL driver that the miniport is done with the RILNDISPACKET structure and its associated buffers, and that the RIL driver is free to release the associated memory. This function is synchronous.

RIL_NDIS_SendPacket

This function is used by the WWAN miniport to call the RIL driver to send a packet through the radio interface. This function is synchronous.

RIL_NDIS_SetGPRSContextActivated

This function sets the GPRS activation state for a context for an NDIS connection.

RIL_ReadMsg

This function reads a message from the current storage location.

RIL_ReadPhonebookEntries

This function reads phonebook entries from the specified range of indices of the current storage location.

RIL_RegisterOnNetwork

This function registers a device on a wireless network.

RIL_RemoveCallForwarding

This function removes a call forwarding rule.

RIL_RemovePreferredOperator

This function removes a specified operator from the list of preferred operators.

RIL_ResetPacketByteCount

This function resets the cumulative count of data bytes transferred by the radio.

RIL_SendAKey

This function sends the user string to the device for authentication key (AKey) verification.

RIL_SendDTMF

This function sends Dual-Tone Multifrequency (DTMF) tones across an established voice call.

RIL_SendFlash

This function sends a flash message.

RIL_SendMsgAcknowledgement

This function sends a message acknowledgement.

RIL_SendMsg

This function sends a message.

RIL_SendRestrictedSimCmd

This function sends a specified restricted command to the SIM.

RIL_SendSimCmd

This function sends a specified command to the SIM.

RIL_SendSimToolkitCmdResponse

This function sends a response to an executed SIM Toolkit command.

RIL_SendSimToolkitEnvelopeCmd

This function sends a SIM Toolkit envelope command.

RIL_SendSimToolkitEventDownload

This function sends a requested event to the SIM.

RIL_SendStoredMsg

This function sends a message from the current storage location.

RIL_SendSupServiceData

This function sends supplementary service (USSD) data.

RIL_SetAudioDevices

This function is implemented by a RIL driver. It is responsible for setting the devices to be used for transmitting and receiving audio from the radio.

RIL_SetAudioGain

This function sets audio gain information.

RIL_SetAudioMuting

This function mutes or un-mutes the input audio device.

RIL_SetBearerServiceOptions

This function sets options related to the data connection bearer service.

RIL_SetCallBarringStatus

This function enables or disables the specified type of call barring.

RIL_SetCallerIdStatus

This function sets the current caller ID status.

RIL_SetCallForwardingStatus

This function enables or disables the specified call forwarding rule.

RIL_SetCallWaitingStatus

This function enables or disables call waiting for the specified information class.

RIL_SetCellBroadcastMsgConfig

This function sets the cell broadcast message configuration.

RIL_SetClosedGroupSettings

This function sets the closed user group settings.

RIL_SetCostInfo

This function sets advice-of-charge settings.

RIL_SetCurrentAddressId

This function sets the current or default address identification for devices that support multiple device addresses.

RIL_SetDataCompression

This function sets data compression options.

RIL_SetDialedIdStatus

This function sets the current status of the dialed ID.

RIL_SetDTMFMonitoring

This function detects DTMF tones from an established voice call.

RIL_SetEquipmentState

This function sets the radio equipment state.

RIL_SetErrorCorrection

This function sets error correction options.

RIL_SetGPRSAttached

This function sets the GPRS attach state.

RIL_SetGPRSClass

This function sets the current GPRS class.

RIL_SetGPRSContextActivated

This function sets the GPRS activation state for a context.

RIL_SetGPRSContext

This function sets a particular GPRS context.

RIL_SetHideConnectedIdStatus

This function sets the current status for the Hide Connected ID option.

RIL_SetHideIdStatus

This function enables or disables Hide ID option.

RIL_SetHSCSDOptions

This function sets High Speed Circuit Switched Data (HSCSD) options.

RIL_SetLockingStatus

This function enables or disables locking status for the specified facility.

RIL_SetMinimumQualityOfService

This function sets the minimum quality of service profile for a context.

RIL_SetMOSMSService

This function sets the preferred Short Message Service (SMS) service option for mobile-originated messages.

RIL_SetMsgConfig

This function sets messaging configuration.

RIL_SetMsgServiceOptions

This function sets messaging service options.

RIL_SetPhonebookOptions

This function sets phonebook options.

RIL_SetRequestedQualityOfService

This function sets the requested quality of service profile for a context.

RIL_SetRLPOptions

This function sets Radio Link Protocol (RLP) options.

RIL_SetRoamingMode

This function sets the CDMA roaming mode.

RIL_SetSimToolkitProfile

This function sets SIM Toolkit terminal profile.

RIL_TerminateSimToolkitSession

This function terminates the SIM Toolkit session.

RIL_TransferCall

This function transfers incoming alerting call to the specified number.

RIL_UnlockPhone

This function removes the current lock applied to the phone.

RIL_UnregisterFromNetwork

This function unregisters the device from the network.

RIL_WriteMsg

This function writes a message to the current storage location.

RIL_WritePhonebookEntry

This function writes a phone book entry to the current storage location.

RILCALLTYPECALLBACK

This callback function determines if an incoming call is a push-to-talk call.

RILNDISRECEIVECALLBACK

This callback function is called when a packet is received by the RIL driver.

RILNDISSTATUSCALLBACK

This callback function is called when a NDIS packet status change occurred in the RIL driver.

RILNDISTRANSMITCALLBACK

This callback function is called when a packet is sent by the RIL driver.

RILNOTIFYCALLBACK

This callback function is called when the radio sends an unsolicited notification.

RILRESULTCALLBACK

This callback function is called to send a return value after an asynchronous RIL function call.

See Also

Reference

RIL Reference