Routines for callback.kb


GetMaxReturned

File Name

callback.kb

Syntax

GetMaxReturned(MetaData, Data: LIST OF STRING)

Parameters

MetaData - describes the data sent to the server

Data - the actual data sent to the server

Returns

If there was a 'MAXRETURNED' tab sent, the value for that

tag is returned

Side Effects

None

Description

Gets the max number to return for a message if any is specified.

Dialog Forms Called

None


LogAppEvent

File Name

callback.kb

Syntax

LogAppEvent(Severity: INTEGER, ErrorNum, EventText: STRING)

Parameters

Severity - the severity of the message

ErrorNum - the code assigned to this type of message

EventText - the actual message to log

Returns

None

Side Effects

None

Description

Sends a message to the dispatcher to log a message to the event window.

Dialog Forms Called

None


PerformClientCallback

File Name

callback.kb

Syntax

PerformClientCallback(hdlClient: NETCONNECTION, ClientRef: STRING, PortNum: INTEGER, CliWin: WINDOW, SubMessage: INTEGER, MetaData: LIST OF STRING, Data: LIST OF STRING)

Parameters

hdlClient - the net connection to the client

ClientRef - the name of the machine the client is on

PortNum - the port the client is listening on

CliWin - the window that is handling the client request

SubMessage - stores the action to take for the client

MetaData - stores a description of the data from the client

Data - stores the data from the client

Returns

1 if the client successfully responds to the callback

Side Effects

None

Description

Gets details for a request initiated by a client.

Dialog Forms Called

None


PerformWorkForCallback

File Name

callback.kb

Syntax

PerformWorkForCallback(hdlClient: NETCONNECTION, CliWin: WINDOW, SubMessage: INTEGER, MetaData: LIST OF STRING, Data: LIST OF STRING)

Parameters

hdlClient - the net connection to the client

CliWin - the window that is handling the client request

SubMessage - the action to take for the client

MetaData - a description of the data from the client

Data - the data from the client

Returns

None

Side Effects

None

Description

Performs some work for a client as defined by the request sent. Data is returned to the client upon completion of the work.

Dialog Forms Called

None


PerformWorkForCallback

File Name

callback.kb

Syntax

PerformWorkForCallback(hdlClient: NETCONNECTION, CliWin: WINDOW, SubMessage: INTEGER, MetaData: LIST OF STRING, Data: LIST OF STRING)

Parameters

hdlClient - the net connection to the client

CliWin - the window that is handling the client request

SubMessage - the action to take for the client

MetaData - a description of the data from the client

Data - the data from the client

Returns

None

Side Effects

None

Description

Performs some work for a client as defined by the request sent. Data is returned to the client upon completion of the work.

Dialog Forms Called

None


PerformWorkForCallback

File Name

callback.kb

Syntax

PerformWorkForCallback(hdlClient: NETCONNECTION, CliWin: WINDOW, SubMessage: INTEGER, MetaData: LIST OF STRING, Data: LIST OF STRING)

Parameters

hdlClient - The net connection to the client

CliWin - The window that is handling the client request

SubMessage - The action to take for the client

MetaData - A description of the data from the client

Data - The data from the client

Returns

None

Side Effects

None

Description

Performs some work for a client as defined by the request sent. Data will be sent back to the client upon completion of the work.

Dialog Forms Called

None


PostMessageToClient

File Name

callback.kb

Syntax

PostMessageToClient(hdlCLient: NETCONNECTION CliWin: WINDOW, Message: INTEGER, MetaData: LIST OF STRING Data: LIST OF STRING)

Parameters

hdlClient - net Connection to the client

CliWin - if client is a TSD client, the window

handle manages the request

Message - the response message to the request sent

MetaData - describes contents of data

Data - data to send to client

Returns

None

Side Effects

None

Description

Sends a packet of data to a client.

Dialog Forms Called

None