RemoteLink class

Section contents

Overview
Construction / destruction
- NewRemoteLink - Constructor
- DeleteRemoteLink - Destructor
Methods provided

Overview

Defined in

ccomms.oxh

`See Also`

Construction / destruction

NewRemoteLink - Constructor

Usage

this& = NewRemoteLink&:

Description

Creates a remote linkobject and returns a handle which allows the object to be manipulated.

Return Value

this& An value which represents the created object

Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example

  LOCAL this&

  this& = NewRemoteLink&:
  DeleteRemoteLink:(this&)

DeleteRemoteLink - Destructor

Usage

DeleteSerialInfo:(BYREF this&)

Description

Destroys the remote link object.

Arguments

BYREF this& A handle to a remote link object

Example

  LOCAL this&

  this& = NewRemoteLink&:
  DeleteRemoteLink:(this&)

Methods provided

RemoteLinkCancelAll

Usage

RemoteLinkCancelAll:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

RemoteLinkCancelLoadRemoteServer

Usage

RemoteLinkCancelLoadRemoteServer:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

RemoteLinkCancelNotifyStatusChng

Usage

RemoteLinkCancelNotifyStatusChng:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

RemoteLinkClose

Usage

RemoteLinkClose:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

RemoteLinkConfig

Usage

result% = RemoteLinkConfig%:(this&,BYREF port&, BYREF module&, BYREF lowPowerMode%)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`BYREF port&`	<TBS>
`BYREF module&`	<TBS>
`BYREF lowPowerMode%`	<TBS>

Return Value

result% <TBS>

RemoteLinkDisable

Usage

result% = RemoteLinkDisable%:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

Return Value

result% <TBS>

RemoteLinkEnable

Usage

result% = RemoteLinkEnable%:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

Return Value

result% <TBS>

RemoteLinkEnableFileAccess

Usage

result% = RemoteLinkEnableFileAccess%:(this&,enable%)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`enable%`	<TBS>

Return Value

result% <TBS>

RemoteLinkLoadLocalServer

Usage

result% = RemoteLinkLoadLocalServer%:(this&,result&,filename$,args$)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`result&`	<TBS>
`filename$`	<TBS>
`args$`	<TBS>

Return Value

result% <TBS>

RemoteLinkLoadRemoteServerA

Usage

RemoteLinkLoadRemoteServerA:(this&,result&,filename$,args$,BYREF status&)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`result&`	<TBS>
`filename$`	<TBS>
`args$`	<TBS>
`BYREF status&`	<TBS>

RemoteLinkNotifyStatusChange

Usage

RemoteLinkNotifyStatusChange:(this&,BYREF status&,state&)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`BYREF status&`	<TBS>
`state&`	<TBS>

RemoteLinkOpen

Usage

result% = RemoteLinkOpen%:(this&,interface%)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`interface%`	<TBS>

Return Value

result% <TBS>

RemoteLinkStatus

Usage

result% = RemoteLinkStatus%:(this&,status&)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`status&`	<TBS>

Return Value

result% <TBS>

RemoteLinkUnloadLocalServer

Usage

RemoteLinkStatus%:(this&,name$)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`name$`	<TBS>

RemoteLinkVersion

Usage

version& = RemoteLinkStatus&:(this&)

Description

<TBS>

Arguments

this& A handle to a remote link object

Return Value

version& <TBS>

RemoteLinkWaitForConnect

Usage

RemoteLinkWaitForConnect:(this&,BYREF status&,state&)

Description

<TBS>

Arguments

`this&`	A handle to a remote link object
`BYREF status&`	<TBS>
`state&`	<TBS>