RIL_WritePhonebookEntry (Compact 2013)

  • Article

3/26/2014

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

Syntax

HRESULT RIL_WritePhonebookEntry(
  HRIL hRil,
  const RILPHONEBOOKENTRY* lpEntry
);

Parameters

  • [in] lpEntry
    The RILPHONEBOOKENTRY structure of the phone book entry to write.

    The dwIndex parameter is required.

    Positive dwIndex values specify the phone book entry location.

    dwIndex = RIL_PBINDEX_FIRSTAVAILABLE requests that the system select a location.

    The raAddress parameter is required.

    The wszText parameter is optional.

Return Value

The immediate HRESULT return code values are:

Value

Description

Any positive value

The function completed successfully. The return code is the command ID.

Zero

Unused

E_INVALIDARG

One or more of the parameters, lpEntry or raAddress or wszText, is invalid

Any other negative value

An error value that is defined in the Ril.h file.

Remarks

The function immediately returns a command ID and two asynchronous results occur sometime later.

The asynchronous results call the RILNOTIFYCALLBACK and RILRESULTCALLBACK callback functions registered by using the pfnResult and pfnNotify parameters of RIL_Initialize.

The first asynchronous result is the RILRESULTCALLBACK registered function called with the following values:

Parameter

Value

dwCode

RIL_RESULT_OK

hrCmdID

the command ID

lpData

NULL

The second asynchronous result is the RILNOTIFYCALLBACK registered function called with the following values:

Parameter

Value

dwCode

RIL_NOTIFY_PHONEBOOKENTRYSTORED

hrCmdID

the command ID

lpData

A pointer to the storage index of the entry.

If a positive number was specified in the initial call, this will be equal to that number.

If an error occurs, HRESULT and dwCode contain appropriate error codes.

The RIL proxy translates this function into IOCTL_RIL_WritePhonebookEntry when the RIL proxy calls RIL_IOControl.

Requirements

Header

ril.h

Library

Ril.lib

See Also

Reference

RIL Functions
RIL_Initialize
RILNOTIFYCALLBACK
RILRESULTCALLBACK
RILPHONEBOOKENTRY
Notification Phonebook Constants