Connection Profiles


Functions

SWI_API SWI_RCODE SwiGetProfileSummary (SWI_STRUCT_ProfileSummary *pProfileSummary, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmProfileSummary (SWI_STRUCT_GsmProfileSummary *pProfileSummary, U32 timeout)
SWI_API SWI_RCODE SwiGetProfile (SWI_STRUCT_Profile *pProfile, const U32 nProfileID, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmProfileBasic (SWI_STRUCT_GsmProfileBasic *pProfile, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmProfileQos (SWI_STRUCT_GsmProfileQos *pProfile, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmProfileDns (SWI_STRUCT_GsmProfileDns *pProfile, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmProfileTft (SWI_STRUCT_GsmProfileTft *pProfile, U32 timeout)
SWI_API SWI_RCODE SwiSetProfile (const SWI_STRUCT_Profile *pProfile, const U32 nProfileID, U32 timeout)
SWI_API SWI_RCODE SwiSetGsmProfileBasic (SWI_STRUCT_GsmProfileBasic pProfile, U32 timeout)
SWI_API SWI_RCODE SwiSetGsmProfileQos (SWI_STRUCT_GsmProfileQos pProfile, U32 timeout)
SWI_API SWI_RCODE SwiSetGsmProfileDns (SWI_STRUCT_GsmProfileDns pProfile, U32 timeout)
SWI_API SWI_RCODE SwiSetGsmProfileTft (SWI_STRUCT_GsmProfileTft pProfile, U32 timeout)
SWI_API SWI_RCODE SwiEraseProfile (const U32 nProfileID, U32 timeout)
SWI_API SWI_RCODE SwiSetDefaultProfile (const U32 nProfileID, U32 timeout)
SWI_API SWI_RCODE SwiActivateProfile (const U32 nProfileID, bool Activate, U32 timeout)

Function Documentation

SWI_API SWI_RCODE SwiActivateProfile ( const U32  nProfileID,
bool  Activate,
U32  timeout 
)

This function initiates or destroys a packet session.

Parameters:
[IN] nProfileID: Profile ID to acted on. Profile ID ranges from 1-16 for 3G and newer devices and 1-3 for older (AC7xx and MP7xx) devices.
[IN] Activate: True if the profile should be activated. False if the profile should be deactivated.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed. A SWI_NOTIFY_PktSessionStatus notification will indicate the result of the request.

SWI_RCODE_REQUEST_REJECTED: Activation requests MAY be rejected if FDN is enabled. This behaviour is customizable by the carrier. SwiGetLastError would return "FDN Mismatch".

See SWI_RCODE for other error return codes.

See also:
SWI_NOTIFY_PktSessionStatus

SWI_API SWI_RCODE SwiEraseProfile ( const U32  nProfileID,
U32  timeout 
)

This function will erase the account information from a profile and restore to factory defaults. The profile will then report a status of "deleted".

Parameters:
[IN] nProfileID: Profile ID to be erased. Profile ID ranges from 1-16 for 3G and newer devices and 1-3 for older (AC7xx and MP7xx) devices.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

SWI_RCODE_FAILED: If the profile is active when you attempt to write a new setting, the function will return SWI_RCODE_FAILED.

See SWI_RCODE for other error return codes.

See also:
SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiGetGsmProfileBasic ( SWI_STRUCT_GsmProfileBasic pProfile,
U32  timeout 
)

This function retrieves the basic details of a connection profile.

This function is used with 3G and newer devices. For older devices, use SwiGetProfile.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters:
[IN/OUT] pProfile: Basic profile information. Caller must specify the caller ID.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed by the modem. See nResult defined in SWI_STRUCT_GsmProfileBasic for the status of the request.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_GsmProfileBasic

SWI_NOTIFY_GsmProfileChange

SwiGetGsmProfileQos

SwiGetGsmProfileDns

SwiGetGsmProfileTft

SwiSetGsmProfileBasic

SwiSetGsmProfileQos

SwiSetGsmProfileDns

SwiSetGsmProfileTft

SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmProfileDns ( SWI_STRUCT_GsmProfileDns pProfile,
U32  timeout 
)

This function retrieves the DNS details of a connection profile.

This function is used with 3G and newer devices. For older devices, use SwiGetProfile.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters:
[IN/OUT] pProfile: DNS profile information. Caller must specify the profile ID.
[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_GsmProfileDns

SWI_NOTIFY_GsmProfileChange

SwiGetGsmProfileBasic

SwiGetGsmProfileQos

SwiGetGsmProfileTft

SwiSetGsmProfileBasic

SwiSetGsmProfileQos

SwiSetGsmProfileDns

SwiSetGsmProfileTft

SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmProfileQos ( SWI_STRUCT_GsmProfileQos pProfile,
U32  timeout 
)

This function retrieves the QoS details of a connection profile.

This function is used with 3G and newer devices. For older devices, use SwiGetProfile.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters:
[IN/OUT] pProfile: QoS profile information. Caller must specify the profile ID.
[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_GsmProfileQos

SWI_NOTIFY_GsmProfileChange

SwiGetGsmProfileBasic

SwiGetGsmProfileDns

SwiGetGsmProfileTft

SwiSetGsmProfileBasic

SwiSetGsmProfileQos

SwiSetGsmProfileDns

SwiSetGsmProfileTft

SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmProfileSummary ( SWI_STRUCT_GsmProfileSummary pProfileSummary,
U32  timeout 
)

These function returns a summary of the status of all account profiles, and identifies which one is the default profile for auto connection.

Use this function with 3G and newer devices. SwiGetProfileSummary should be used with older devices.

The summary reports the status of each profile along with its context number. The summary structure reports two profile context identities: one for the default profile used for automatic activation, and another to identify the current profile that is actively connected to the network (activated). If the modem is not currently connected, the current profile context is reported as zero.

Parameters:
[OUT] pProfileSummary: Profile summary information
[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_GsmProfileSummary

SwiGetProfileSummary

SWI_API SWI_RCODE SwiGetGsmProfileTft ( SWI_STRUCT_GsmProfileTft pProfile,
U32  timeout 
)

This function retrieves the TFT details of a connection profile.

This function is used with 3G and newer devices. Older devices do not support TFT configurations.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters:
[IN/OUT] pProfile: TFT profile information. Caller must specify the profile ID.
[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_GsmProfileTft

SWI_NOTIFY_GsmProfileChange

SwiGetGsmProfileBasic

SwiGetGsmProfileDns

SwiGetGsmProfileQos

SwiSetGsmProfileBasic

SwiSetGsmProfileQos

SwiSetGsmProfileDns

SwiSetGsmProfileTft

SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetProfile ( SWI_STRUCT_Profile pProfile,
const U32  nProfileID,
U32  timeout 
)

This function is used to retrieve the details of a connection profile.

This function should only be used with AC7xx and MP7XX devices. For 3G and newer devices, use the following set of profile APIs:

Calling this function on profile that is not present (deleted) returns default profile settings.

Parameters:
[OUT] pProfile: Profile information
[IN] nProfileID: Profile ID to retrieve
[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_Profile

SwiGetGsmProfileBasic

SwiGetGsmProfileQos

SwiGetGsmProfileDns

SwiGetGsmProfileTft

SWI_API SWI_RCODE SwiGetProfileSummary ( SWI_STRUCT_ProfileSummary pProfileSummary,
U32  timeout 
)

This function returns a summary of the status of all account profiles, and identifies which one is the default profile for auto connection.

Use this function with AC7xx and MP7XX devices only For 3G and newer devices, use SwiGetGsmProfileSummary.

The summary reports the status of each profile along with its context number. The summary structure reports two profile context identities: one for the default profile used for automatic activation, and another to identify the current profile that is actively connected to the network (activated). If the modem is not currently connected, the current profile context is reported as zero.

Parameters:
[OUT] pProfileSummary: Profile summary information.
[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_ProfileSummary

SwiGetGsmProfileSummary

SWI_API SWI_RCODE SwiSetDefaultProfile ( const U32  nProfileID,
U32  timeout 
)

This function sets which profile is to be used for possible automatic connection. If the profile that is set to be the default has the auto connection flag set to true, then that profile will be used to connect to the network automatically when the modem is started or reset.

The modem does not verify that the profile contains a valid (non-blank) account. You can set the default to a "deleted" profile; the autoconnect flag will be false so this is equivalent to disabling autoconnection.

Parameters:
[IN] nProfileID: Profile ID to be made the default. Profile ID ranges from 1-16 for 3G and newer devices and 1-3 for older (AC7xx and MP7xx) devices.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed.

See SWI_RCODE for other error return codes.

See also:
SwiGetGsmProfileSummary

SwiGetProfileSummary

SWI_API SWI_RCODE SwiSetGsmProfileBasic ( SWI_STRUCT_GsmProfileBasic  pProfile,
U32  timeout 
)

This function stores the basic user account information in a profile slot, making it available for connection.

This function is used with 3G and newer devices. For older devices, use SwiSetProfile.

Parameters:
[IN] pProfile: Basic profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_GsmProfileBasic

SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetGsmProfileDns ( SWI_STRUCT_GsmProfileDns  pProfile,
U32  timeout 
)

This function stores the DNS user account information in a profile slot.

This function is used with 3G and newer devices. For older devices, use SwiSetProfile.

Parameters:
[IN] pProfile: DNS profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_GsmProfileDns

SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetGsmProfileQos ( SWI_STRUCT_GsmProfileQos  pProfile,
U32  timeout 
)

This function stores the QoS user account information in a profile slot.

This function is used with 3G and newer devices. For older devices, use SwiSetProfile.

Parameters:
[IN] pProfile: QoS profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_GsmProfileQos

SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetGsmProfileTft ( SWI_STRUCT_GsmProfileTft  pProfile,
U32  timeout 
)

This function stores the TFT user account information in a profile slot.

This function is used with 3G and newer devices. Older devices do not support TFT configurations.

Parameters:
[IN] pProfile: TFT profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_GsmProfileTft

SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetProfile ( const SWI_STRUCT_Profile pProfile,
const U32  nProfileID,
U32  timeout 
)

This function stores the user connection information in a profile slot, making it available for connection.

This function should only be used with AC7xx and MP7XX devices. For 3G and newer devices, use the following set of profile APIs:

For a profile with bAutomaticIP set to true, the API will force the setting of dwPDPAddress to zeros. Automatic IP setting takes precedence over a user-assigned IP.

Parameters:
[IN] pProfile: Profile information to be written to modem.
[IN] nProfileID: Profile ID to be updated
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_Profile

SWI_NOTIFY_GsmProfileChange

SwiSetGsmProfileBasic

SwiSetGsmProfileQos

SwiSetGsmProfileDns

SwiSetGsmProfileTft


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