WSConnection object

The WSConnection object lets you set user-related, session-related, and authentication information when you connect to and process data from a Web service data source.

Properties

WSConnection property

Datatype

Description

AuthenticationMode

String

Specifies the authentication mode you want to use. This can be “basic” or “digest”. These AuthenticationMode values are described on the Microsoft MSDN Web site.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

ClientCertificateFile

String

The name of the certificate file or files you want to use to connect to a Web service. The string value could include local files with a full path and URLs to remote certificate files. You must use a semicolon as a separator for multiple files.

Endpoint

String

Specifies a URL for the remote Web Service and tells the Web Service engine where the Web service resides. If the endpoint is not set, the Web Service engine uses the default endpoint embedded in the WSDL file.

Password

String

Specifies the password of the user who will consume the Web service.

ProxyServerHostName

String

Specifies the name of the proxy server host if the client machine is behind a firewall.

ProxyServerPassword

String

Specifies a password for the current user if a proxy server requests a user name and password. If the client machine is directly connected to the Internet, this property does not need to be set.

ProxyServerPort

UInteger

Specifies the port number of a proxy server if the client machine is behind a firewall.

ProxyServerUserName

String

Specifies the user name for a proxy server if the client machine is behind a firewall. If the client machine is directly connected to the Internet, this property does not need to be set.

Timeout

Long

Specifies the timeout period in seconds when invoking the Web service. The default value is 0, which does not set a timeout period for the Web service connection on the client side. (The Web service might still have a timeout value on the server side.)

UserDomain

String

Specifies the domain the user is working in. This property is used together with UserName and Password properties for a fully qualified user identification.

UserName

String

Specifies the name of the user who will consume the Web service.

UseWindowsIntegratedAuthentication

Boolean

Specifies whether the connection object uses integrated Windows authentication. Values are:

  • TRUE – The application uses Windows authentication.

  • FALSE – The application does not use Windows authentication.

If this option is set to true, you do not need to set the UserName, Password, or UserDomain properties.

Events

WSConnection event

Occurs

Constructor

Immediately before the Open event occurs in the window

Destructor

Immediately after the Close event occurs in the window

Functions

WSConnection function

Datatype returned

Description

ClassName

String

Returns the name assigned to the control

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service

GetParent

PowerObject

Returns a reference to the name of the parent object

PostEvent

Boolean

Adds an event to the end of the message queue for control

TriggerEvent

Integer

Triggers a specified event in the control and executes the script for the event

TypeOf

Object

Returns the type of the control