Supplementary Services


Functions

SWI_API SWI_RCODE SwiStartSSPassReg (SWI_STRUCT_SS_PasswordReg *sSSPassReg, U32 timeout)
SWI_API SWI_RCODE SwiSetSSPassword (SWI_STRUCT_SS_PasswordStatus *sSSPassStatus, U32 timeout)
SWI_API SWI_RCODE SwiSetSSRequest (SWI_STRUCT_SS_Request *sSSRequest, U32 timeout)
SWI_API SWI_RCODE SwiAbortRequest (SWI_STRUCT_SS_Abort *sSSAbort, U32 timeout)

Function Documentation

SWI_API SWI_RCODE SwiAbortRequest ( SWI_STRUCT_SS_Abort sSSAbort,
U32  timeout 
)

This function is used to cancel an outstanding supplementary service operation.

Parameters:
[IN] SWI_STRUCT_SS_Abort: Specifies the supplementary services request to be canceled
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SS_Abort

SWI_NOTIFY_SSRespCancel

SWI_NOTIFY_SSRespRelease

SWI_API SWI_RCODE SwiSetSSPassword ( SWI_STRUCT_SS_PasswordStatus sSSPassStatus,
U32  timeout 
)

This function is used to enter a supplementary services password.

It will be called in response to a received SWI_NOTIFY_SSPasswordStatus notification. The notification will indicate what kind of password needs to be entered.

The SWI_NOTIFY_SSRespPassword notification will indicate if the supplementary services password process has been successful.

If an incorrect or invalid password has been entered, this will be communicated in the SWI_NOTIFY_SSPasswordStatus notification.

Parameters:
[IN] sSSPassStatus: Specifies the supplementary services request to be canceled
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SS_PasswordStatus

SWI_NOTIFY_SSPasswordStatus

SWI_NOTIFY_SSRespPassword

SWI_API SWI_RCODE SwiSetSSRequest ( SWI_STRUCT_SS_Request sSSRequest,
U32  timeout 
)

This function is used to initiate supplementary services operations through one of five request types: erase, register, activate, deactivate and interrogate.

The requested operation will be assumed to affect all supplementary services if no basic service group information is specified in the request.

The device will return the supplementary service handle assigned to the request operation. This handle allow the caller to map the network response received in one many supplementary service notification to this requested operation.

The handle can also be used to cancel the requested operation.

Parameters:
[IN/OUT] sSSRequest: Supplementary services request information
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SS_Request

SWI_NOTIFY_SSRespOK

SWI_NOTIFY_SSRespFwdInfo

SWI_NOTIFY_SSRespCallBar

SWI_NOTIFY_SSRespInfoData

SWI_NOTIFY_SSRespStatus

SWI_NOTIFY_SSRespFwdNum

SWI_NOTIFY_SSRespBSList

SWI_NOTIFY_SSRespFwdList

SWI_NOTIFY_SSRespRaw

SWI_NOTIFY_SSRespPassword

SWI_NOTIFY_SSRespClir

SWI_NOTIFY_SSRespError

SWI_NOTIFY_SSRespReject

SWI_NOTIFY_SSRespCancel

SWI_NOTIFY_SSRespRelease

SWI_NOTIFY_SSNotify

SwiAbortRequest

SWI_API SWI_RCODE SwiStartSSPassReg ( SWI_STRUCT_SS_PasswordReg sSSPassReg,
U32  timeout 
)

This function initiates a network password registration procedure for either the call barring password or the general supplementary services password.

A handle assigned to this registration request will be returned to the caller by this function.

Parameters:
[IN/OUT] sSSPassReg: Specifies the kind of password being registered
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SS_PasswordReg

SWI_NOTIFY_SSPasswordStatus


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