Client API - File Methods


Home>Product Description>Programmer API>Client API

Client API

These methods are contained in the WebPublisher Studio External Tools library wpxtools.lbs
This library must be loaded by the startup task of the client library.

File Methods

$GetVersion

Returns the tool client tools library version.

Syntax

Do code method wpxtools.api/$GetVersion() Returns cVersion

cVersion

character variable that receives the version string.


$SetHost

Writes the specified host to a text file called "host" in the same directory as the client tools library.

Syntax

Do code method wpxtools.api/$SetHost(cIP,iPort) Returns cErrMsg

cIP

character - the host IP address.

iPort

long integer - the host port.

cErrMsg

character variable that receives an error message, empty if no error occurred.


$GetHost

Reads the host file and returns the host.

Syntax

Do code method wpxtools.api/$GetHost(cIP,iPort) Returns cErrMsg

cIP

character variable that receives the host IP address.

iPort

long integer variable that receives the host port.

cErrMsg

character variable that receives an error message, empty if no error occurred.

©Corporate Windows Pty Limited 2012 Previous | Next