LinuxSDK  V1.4.0.5
Data Fields
SWI_STRUCT_Profile Struct Reference

#include <SwiApiGsmNetwork.h>

Data Fields

swi_uint32 sizeStruct
 
swi_char szLabel [LENGTH_Label]
 
swi_char szUserName [LENGTH_UserName]
 
swi_char szPassword [LENGTH_Password]
 
swi_char szAccessPoint [LENGTH_AccessPointName]
 
swi_bool bDataCompression
 
swi_bool bHeaderCompression
 
swi_bool bAutoActivation
 
swi_bool bAutomaticIP
 
enum SWI_TYPE_PDP ePDP
 
enum SWI_TYPE_Precedence eReqPrecedence
 
enum SWI_TYPE_Delay eReqDelay
 
enum SWI_TYPE_Reliability eReqReliability
 
enum SWI_TYPE_PeakThroughput eReqPeakThroughput
 
enum SWI_TYPE_MeanThroughput eReqMeanThroughput
 
enum SWI_TYPE_Precedence eMinPrecedence
 
enum SWI_TYPE_Delay eMinDelay
 
enum SWI_TYPE_Reliability eMinReliability
 
enum SWI_TYPE_PeakThroughput eMinPeakThroughput
 
enum SWI_TYPE_MeanThroughput eMinMeanThroughput
 
swi_uint32 dwPrimaryDns
 
swi_uint32 dwSecondaryDns
 
swi_uint32 dwPDPAddress
 
swi_bool bReadOnly
 
swi_bool bPromptPassword
 
swi_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

Field Documentation

swi_bool SWI_STRUCT_Profile::bAutoActivation

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.

swi_bool SWI_STRUCT_Profile::bAutomaticIP

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.

swi_bool SWI_STRUCT_Profile::bAutoRunVPN

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

swi_bool SWI_STRUCT_Profile::bDataCompression

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.

swi_bool SWI_STRUCT_Profile::bHeaderCompression

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.

swi_bool SWI_STRUCT_Profile::bPromptPassword

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

swi_bool SWI_STRUCT_Profile::bReadOnly

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.

swi_uint32 SWI_STRUCT_Profile::dwPDPAddress

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

swi_uint32 SWI_STRUCT_Profile::dwPrimaryDns

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

swi_uint32 SWI_STRUCT_Profile::dwSecondaryDns

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

enum SWI_TYPE_Delay SWI_STRUCT_Profile::eMinDelay

Minimum QoS delay value.

enum SWI_TYPE_MeanThroughput SWI_STRUCT_Profile::eMinMeanThroughput

Minimum QoS mean throughput.

enum SWI_TYPE_PeakThroughput SWI_STRUCT_Profile::eMinPeakThroughput

Minimum QoS peak throughput.

enum SWI_TYPE_Precedence SWI_STRUCT_Profile::eMinPrecedence

Minimum QoS precedence value.

enum SWI_TYPE_Reliability SWI_STRUCT_Profile::eMinReliability

Minimum QoS reliability value.

enum SWI_TYPE_PDP SWI_STRUCT_Profile::ePDP

PDP type (either IP or PPP).

enum SWI_TYPE_Delay SWI_STRUCT_Profile::eReqDelay

Requested QoS delay value.

enum SWI_TYPE_MeanThroughput SWI_STRUCT_Profile::eReqMeanThroughput

Requested QoS mean throughput.

enum SWI_TYPE_PeakThroughput SWI_STRUCT_Profile::eReqPeakThroughput

Requested QoS peak throughput.

enum SWI_TYPE_Precedence SWI_STRUCT_Profile::eReqPrecedence

Requested QoS precedence value.

enum SWI_TYPE_Reliability SWI_STRUCT_Profile::eReqReliability

Requested QoS reliability value.

swi_uint32 SWI_STRUCT_Profile::sizeStruct

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

swi_char SWI_STRUCT_Profile::szAccessPoint[LENGTH_AccessPointName]

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

swi_char SWI_STRUCT_Profile::szLabel[LENGTH_Label]

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

swi_char SWI_STRUCT_Profile::szPassword[LENGTH_Password]

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

swi_char 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:

Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved