Phonebook


Functions

SWI_API SWI_RCODE SwiGetPhonebookAvailable (SWI_STRUCT_PHONEBK_Available *pPhonebook, U32 timeout)
SWI_API SWI_RCODE SwiGetPhonebookSize (SWI_STRUCT_PHONEBK_Size *pPhonebook, U32 timeout)
SWI_API SWI_RCODE SwiGetPhonebookEntry (SWI_STRUCT_PHONEBK_Entry *pPhonebook, U32 timeout)
SWI_API SWI_RCODE SwiAddPhonebookEntry (SWI_STRUCT_PHONEBK_Entry *pPhonebook, U32 timeout)
SWI_API SWI_RCODE SwiEditPhonebookEntry (SWI_STRUCT_PHONEBK_Entry *pPonebook, U32 timeout)
SWI_API SWI_RCODE SwiDeletePhonebookEntry (SWI_STRUCT_PHONEBK_DeleteEntry *pPhonebook, U32 timeout)
SWI_API SWI_RCODE SwiDeletePhonebookLastNum (const SWI_TYPE_Phonebook ePhonebookType, U32 timeout)
SWI_API SWI_RCODE SwiGetFdnMode (bool *pFdnEnabled, U32 timeout)
SWI_API SWI_RCODE SwiSetFdnMode (SWI_STRUCT_FdnMode *pFdn, U32 timeout)
SWI_API SWI_RCODE SwiChv2StatusKick (SWI_TYPE_SIM_Chv2KickType eKickType, U32 timeout)
SWI_API SWI_RCODE SwiGetEmergencyEntry (SWI_STRUCT_Emergency_Number *pEmergencyNumber, bool bFirst, U32 timeout)

Function Documentation

SWI_API SWI_RCODE SwiAddPhonebookEntry ( SWI_STRUCT_PHONEBK_Entry pPhonebook,
U32  timeout 
)

Use this function to add a phonebook entry.

This function should not be called until the SWI_NOTIFY_PhonebookReady has been received indicating phonebooks are ready.

Parameters:
[IN/OUT] pPhonebook: Phonebook entry to be added. The structure size, phonebook type, name, and number must be supplied by the caller. The phonebook entry ID is returned in the same structure and should be stored to be used to for modify or deleting the entry later.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid. See pPhonebook->eResultCode for result of the operation.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_PHONEBK_Entry

SWI_NOTIFY_PhonebookReady

SwiGetPhonebookEntry

SwiEditPhonebookEntry

SwiDeletePhonebookEntry

SwiDeletePhonebookLastNum

SWI_API SWI_RCODE SwiChv2StatusKick ( SWI_TYPE_SIM_Chv2KickType  eKickType,
U32  timeout 
)

This function is used to get CHV2 status from the modem.

SIM API functions can not be called until a SWI_NOTIFY_SimStatusExp notification is received. This indicates that the SIM is ready to process user requests.

The kick type determines if the user is prompted to enter the CHV2. For example, if the card is kicked for CHV2 verify, then SWI_NOTIFY_SimStatusExp will contain a user prompt to enter CHV2. If the card is kicked for CHV2 change, SWI_NOTIFY_SimStatusExp will not contain user prompts.

Parameters:
[IN] eKickType: CHV2 kick type
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed. The SWI_NOTIFY_SimStatusExp notification indicates the result of the operation and any additional actions required by the user.

See SWI_RCODE for other error return codes.

See also:
SWI_TYPE_SIM_Chv2KickType

SWI_NOTIFY_SimStatusExp

SWI_API SWI_RCODE SwiDeletePhonebookEntry ( SWI_STRUCT_PHONEBK_DeleteEntry pPhonebook,
U32  timeout 
)

Use this function to delete a phonebook entry.

This function should not be called until the SWI_NOTIFY_PhonebookReady has been received indicating phonebooks are ready.

Parameters:
[IN/OUT] pPhonebook: Phonebook entry to be deleted. The structure size, phonebook entry, and phonebook type must be supplied by the caller.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid. See pPhonebook->eResultCode for result of the operation.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_PHONEBK_DeleteEntry

SWI_NOTIFY_PhonebookReady

SwiGetPhonebookEntry

SwiAddPhonebookEntry

SwiEditPhonebookEntry

SwiDeletePhonebookLastNum

SWI_API SWI_RCODE SwiDeletePhonebookLastNum ( const SWI_TYPE_Phonebook  ePhonebookType,
U32  timeout 
)

Use this function to clear the entire last numbers dialed, last numbers missed or last numbers received phonebooks.

This function should not be called until the SWI_NOTIFY_PhonebookReady has been received indicating phonebooks are ready.

Parameters:
[IN] ePhonebookType: Phonebook to be cleared
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid.

See SWI_RCODE for other error return codes.

See also:
SWI_TYPE_Phonebook

SWI_NOTIFY_PhonebookReady

SwiGetPhonebookEntry

SwiAddPhonebookEntry

SwiEditPhonebookEntry

SwiDeletePhonebookEntry

SWI_API SWI_RCODE SwiEditPhonebookEntry ( SWI_STRUCT_PHONEBK_Entry pPonebook,
U32  timeout 
)

This function is used to modify an existing phonebook entry.

This function should not be called until the SWI_NOTIFY_PhonebookReady has been received indicating phonebooks are ready.

The phonebook entry must be known ahead of time (either returned from SwiAddPhonebookEntry or SwiGetPhonebookEntry).

Parameters:
[IN/OUT] pPhonebook: Replacement phonebook entry. The structure size, phonebook entry, phonebook type, name, and number must be supplied by the caller.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid. See pPhonebook->eResultCode for result of the operation.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_PHONEBK_Entry

SWI_NOTIFY_PhonebookReady

SwiGetPhonebookEntry

SwiAddPhonebookEntry

SwiDeletePhonebookEntry

SwiDeletePhonebookLastNum

SWI_API SWI_RCODE SwiGetEmergencyEntry ( SWI_STRUCT_Emergency_Number pEmergencyNumber,
bool  bFirst,
U32  timeout 
)

The modem contains a list of emergency numbers. This function is used to fetch the emergency numbers one at a time. Set the first flag when calling this function to retrieve the first entry in the list. To retrieve the entire list call this function repeatedly.

This function sends a request to the modem. The modem's response will contain an emergency number string and indicate if this is the last number in the list.

Parameters:
[IN/OUT] pEmergencyNumber: Phonebook entry
[IN] bfirst: First emergency number flag (this flag should only be set the first time this function is called)
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request is being processed.

SWI_RCODE_REQUEST_TIMEOUT The request has timed out

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_Emergency_Number

SWI_API SWI_RCODE SwiGetFdnMode ( bool *  pFdnEnabled,
U32  timeout 
)

This function is used to request the fixed number dialing (FDN) mode from the modem.

Parameters:
[OUT] pFdnEnabled: True if FDN is enabled, false otherwise.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid.

See SWI_RCODE for other error return codes.

See also:
SwiSetFdnMode

SWI_API SWI_RCODE SwiGetPhonebookAvailable ( SWI_STRUCT_PHONEBK_Available pPhonebook,
U32  timeout 
)

This function is used to determine what phonebooks are available.

This function should only be called after a SWI_NOTIFY_PhonebookReady notification has been received indicating phonebooks are ready.

Parameters:
[OUT] pPhonebook: Phonebook availability status
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_PHONEBK_Available

SWI_NOTIFY_PhonebookReady

SWI_API SWI_RCODE SwiGetPhonebookEntry ( SWI_STRUCT_PHONEBK_Entry pPhonebook,
U32  timeout 
)

This function is used to retrieve a phonebook entry.

This function should not be called until the SWI_NOTIFY_PhonebookReady has been received indicating phonebooks are ready.

There are several different phonebooks on the modem and SIM. This function can request either the first or next entry be read from a particular phonebook. To get the entire contents of a phonebook call this function requesting the first entry and then repeatedly request the next entry for all subsequent function calls.

Parameters:
[IN/OUT] pPhonebook: Phonebook entry information. The structure size, phonebook type, and bReadFromStart flag must be populated by the caller. The other fields are returned from the modem. Note that you can not read a phonebook entry directly by specifying the entry ID.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid. See pPhonebook->eResultCode for result of the operation.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_PHONEBK_Entry

SWI_NOTIFY_PhonebookReady

SwiAddPhonebookEntry

SwiEditPhonebookEntry

SwiDeletePhonebookEntry

SwiDeletePhonebookLastNum

SWI_API SWI_RCODE SwiGetPhonebookSize ( SWI_STRUCT_PHONEBK_Size pPhonebook,
U32  timeout 
)

This function is used to query the number of remaining free entries and the size of all of the phonebooks on the SIM.

This function should not be called until the SWI_NOTIFY_PhonebookReady has been received indicating phonebooks are ready.

Parameters:
[OUT] pPhonebook: Phonebook availability status
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_PHONEBK_Size

SWI_NOTIFY_PhonebookReady

SWI_API SWI_RCODE SwiSetFdnMode ( SWI_STRUCT_FdnMode pFdn,
U32  timeout 
)

This function is used to set the fixed number dialing (FDN) mode on the modem.

Before calling this function, CHV2 must be verified. CHV2 is prompted for by calling SwiChv2StatusKick.

Parameters:
[IN/OUT] pFdn: Set bEnabled to true to enable FDN, false otherwise. eResultCode contains the result of the request.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed and values returned are valid. See eResultCode within the SWI_STRUCT_FdnMode structure for the result of the operation.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_FdnMode

SwiChv2StatusKick

SwiGetFdnMode


Generated on Fri Oct 2 10:27:31 2009 for 3G SDK by  doxygen 1.5.9