Description

Sets http proxy online options.

Syntax

[Visual Basic .NET]
Public Function SetOnlineOptions( _ ByVal UseProxy As Boolean, _ ByVal ServerName As String, _ ByVal PortNum As Integer, _ ByVal UserName As String, _ ByVal Password As String, _ ByVal SavePassword As Boolean _ ) As Boolean

[Visual Basic .NET]

Public Function SetOnlineOptions( _
   ByVal UseProxy As Boolean, _
   ByVal ServerName As String, _
   ByVal PortNum As Integer, _
   ByVal UserName As String, _
   ByVal Password As String, _
   ByVal SavePassword As Boolean _
) As Boolean

[C#]
public bool SetOnlineOptions( bool UseProxy, string ServerName, int PortNum, string UserName, string Password, bool SavePassword );

[C#]

public bool SetOnlineOptions(

   bool UseProxy, 

   string ServerName, 

   int PortNum, 

   string UserName, 

   string Password, 

   bool SavePassword

);

[Managed C++]
public: bool SetOnlineOptions( bool UseProxy, String __gc ^ ServerName, int PortNum, String __gc ^ UserName, String __gc ^ Password, bool SavePassword );

[Managed C++]

public: bool SetOnlineOptions(

   bool UseProxy, 

   String __gc ^ ServerName, 

   int PortNum, 

   String __gc ^ UserName, 

   String __gc ^ Password, 

   bool SavePassword

);

[Java]
public bool setOnlineOptions( bool UseProxy, String ServerName, int PortNum, String UserName, String Password, bool SavePassword );

[Java]

public bool setOnlineOptions(

   bool UseProxy, 

   String ServerName, 

   int PortNum, 

   String UserName, 

   String Password, 

   bool SavePassword

);

[Unmanaged C++]
public: HRESULT SetOnlineOptions( VARIANT_BOOL UseProxy, BSTR ServerName, long PortNum, BSTR UserName, BSTR Password, VARIANT_BOOL SavePassword, VARIANT_BOOL * ReturnValue );

[Unmanaged C++]

public: HRESULT SetOnlineOptions(

   VARIANT_BOOL UseProxy, 

   BSTR ServerName, 

   long PortNum, 

   BSTR UserName, 

   BSTR Password, 

   VARIANT_BOOL SavePassword, 

   VARIANT_BOOL * ReturnValue

);

Parameters

UseProxy: If set to True, the proxy information is used/set.
ServerName: Server name or IP address of the HTTP server.
PortNum: Port number used for proxy.
UserName: User name for proxy server
Password: Password for proxy server.
SavePassword: If set to True, password is saved.

Return Type

Returns True if the values were set successfully; otherwise returns False.

Remarks

Use SetOnlineOptions to specify the correct Server and Port information and, optionally, a proxy username and password. Use this option if your internet access is via a firewall. If you are unsure how your internet connection is configured, please consult your system administrator.

Example

[Visual Basic .NET] Copy Code

Dim UseProxy As
Boolean

Dim ServerName As String

Dim PortNum As Long

Dim UserName As String

Dim Password As String

Dim SavePassword As Boolean

Dim RetVal As Boolean



UseProxy = True

ServerName = "ftp.agi.com"

PortNum = 8088

UserName = "agiuser"

Password = "secret"

SavePassword = False





RetVal = StkXApp.SetOnlineOptions(UseProxy, ServerName, _

    PortNum, UserName, Password,
SavePassword)

...