SWI_STRUCT_Profile Struct Reference

#include <SwiStructsGsm.h>

List of all members.

Public Attributes

U32 sizeStruct
WCHAR szLabel [LENGTH_Label]
WCHAR szUserName [LENGTH_UserName]
WCHAR szPassword [LENGTH_Password]
WCHAR szAccessPoint [LENGTH_AccessPointName]
bool bDataCompression
bool bHeaderCompression
bool bAutoActivation
bool bAutomaticIP
SWI_TYPE_PDP ePDP
SWI_TYPE_Precedence eReqPrecedence
SWI_TYPE_Delay eReqDelay
SWI_TYPE_Reliability eReqReliability
SWI_TYPE_PeakThroughput eReqPeakThroughput
SWI_TYPE_MeanThroughput eReqMeanThroughput
SWI_TYPE_Precedence eMinPrecedence
SWI_TYPE_Delay eMinDelay
SWI_TYPE_Reliability eMinReliability
SWI_TYPE_PeakThroughput eMinPeakThroughput
SWI_TYPE_MeanThroughput eMinMeanThroughput
DWORD dwPrimaryDns
DWORD dwSecondaryDns
DWORD dwPDPAddress
bool bReadOnly
bool bPromptPassword
bool bAutoRunVPN


Detailed Description

Profile data structure used to read and store account information.

This structure should only be used with 2G devices.

See also:
SWI_TYPE_PDP

SWI_TYPE_Precedence

SWI_TYPE_Delay

SWI_TYPE_Reliability

SWI_TYPE_PeakThroughput

SWI_TYPE_MeanThroughput

SwiGetProfile

SwiSetProfile


Member Data Documentation

True indicates that this account should be automatically connected if the profile is designated as default (see SwiSetDefaultProfile). False indicates the host software must manually request to connect with this account.

True indicates the IP address is to be manually assigned (dwPDPAddress), false indicates the IP address is to be dynamically assigned by the network. Note that DHCP is not necessarily exchanged over the air.

True indicates to the host application a VPN client should be ran automatically after a successful connection is made. Otherwise, false is returned.

True indicates V.42bis is to be used for data, false indicates data compression is off. The carrier indicates if this is supported. It is always safe to leave as "false", although throughput may be reduced.

True indicates TCP header compression is on, false indicates header compression is off. The carrier indicates if this is supported. It is always safe to leave as "false", although throughput may be reduced.

True is returned if the user should be prompted to enter a password. Otherwise, false is returned.

True is returned if the profile is read only. Otherwise, false is returned. Note that the read only attribute is a host software enforced restriction. The modem will simply save any information the host software sends down.

The modem's dedicated IP address in cases where bAutomaticIP is set to false.

Primary DNS can be defined, or if set to 0.0.0.0, obtained from the network (where the network supports automatic assignment).

Secondary DNS can be defined, or if set to 0.0.0.0, obtained from the network (where the network supports automatic assignment).

Minimum QoS delay value.

SWI_TYPE_MeanThroughput SWI_STRUCT_Profile::eMinMeanThroughput

Minimum QoS mean throughput.

SWI_TYPE_PeakThroughput SWI_STRUCT_Profile::eMinPeakThroughput

Minimum QoS peak throughput.

Minimum QoS precedence value.

Minimum QoS reliability value.

PDP type (either IP or PPP).

Requested QoS delay value.

SWI_TYPE_MeanThroughput SWI_STRUCT_Profile::eReqMeanThroughput

Requested QoS mean throughput.

SWI_TYPE_PeakThroughput SWI_STRUCT_Profile::eReqPeakThroughput

Requested QoS peak throughput.

Requested QoS precedence value.

Requested QoS reliability value.

The size, in bytes, of this structure. This value must always be populated by the calling application.

WCHAR SWI_STRUCT_Profile::szAccessPoint[LENGTH_AccessPointName]

A NULL terminated string representing the access point name provided by the carrier.

WCHAR SWI_STRUCT_Profile::szLabel[LENGTH_Label]

A NULL terminated string representing a user-supplied "handle" to help them identify the account.

WCHAR SWI_STRUCT_Profile::szPassword[LENGTH_Password]

A NULL terminated string representing the account password for carrier authentication.

WCHAR SWI_STRUCT_Profile::szUserName[LENGTH_UserName]

A NULL terminated string representing the carrier assigned account name for carrier authentication.


The documentation for this struct was generated from the following file:

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