TolliumControllerBase::GetClientState (open)

Request client to send its state to us. Warning: experimental! Interval won't run and callbacks may occur from within this function.

Syntax

LOADLIB "mod::tollium/lib/internal/controllerbase.whlib";

STRING FUNCTION GetClientState(RECORD options)

Parameters

RECORD options

Options

lockclient

Whether to lock the client (with a busylock) until the next message loop is entered.

timeout

Time to wait until (pass MAX_DATETIME to wait forever)

Return value

STRING

One of the following values: 'ok' (sync done), 'timeout' (no response from client), 'closed' (screen closed by client)