STK X Send comments on this topic.
GetOnlineOptions Method (AgSTKXApplication)
See Also  Example
UseProxy
If True is returned, the proxy information was used.
ServerName
Server name or IP address of the HTTP server.
PortNum
Port number used for proxy.
UserName
User name for proxy server.





Description

Retrieves http proxy online options.

Syntax

[Visual Basic .NET] 
Public Function GetOnlineOptions( _
   ByRef UseProxy As Boolean, _
   ByRef ServerName As String, _
   ByRef PortNum As Integer, _
   ByRef UserName As String _
) As Boolean
[C#] 
public bool GetOnlineOptions(

   ref bool UseProxy, 

   ref string ServerName, 

   ref int PortNum, 

   ref string UserName

);
[Managed C++] 
public: bool GetOnlineOptions(

   bool ^ UseProxy, 

   String __gc ^ ^ ServerName, 

   int ^ PortNum, 

   String __gc ^ ^ UserName

);
[Java] 
public bool getOnlineOptions(

   bool UseProxy, 

   String ServerName, 

   int PortNum, 

   String UserName

);
[Unmanaged C++] 
public: HRESULT GetOnlineOptions(

   VARIANT_BOOL * UseProxy, 

   BSTR * ServerName, 

   long * PortNum, 

   BSTR * UserName, 

   VARIANT_BOOL * ReturnValue

);

Parameters

UseProxy
If True is returned, the proxy information was used.
ServerName
Server name or IP address of the HTTP server.
PortNum
Port number used for proxy.
UserName
User name for proxy server.

Return Type

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

Example

[Visual Basic .NET] Copy Code
Dim UseProxy As Boolean
Dim ServerName As String
Dim PortNum As Long
Dim UserName As String
Dim RetVal As Boolean

RetVal = StkXApp.GetOnlineOptions(UseProxy, ServerName, _
    PortNum, UserName)
...

See Also

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1