%SYN_GETSTATE

Retrieve a Synergy state option

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX

 

 
status = %SYN_GETSTATE(request, [channel], backup_mode)

or

xcall SYN_GETSTATE(request, [channel], backup_mode)

Return value

status

One of the following values: (n)

0 = Successful

1 = Not successful

Arguments

request

0 = Return the current backup mode. (n)

channel

(optional) The channel of a file opened via xfServer for which the current backup mode is being requested. (n)

backup_mode

Returned with one of the following backup modes: (n)

0 = Off

1 = On

2 = Pending

3 = Not Allowed

4 = Disabled

Discussion

%SYN_GETSTATE enables you to determine the current backup mode. If channel is passed, it indicates that the caller is requesting the current backup mode for the server machine on which the specified channel is open.

If %SYN_GETSTATE is run from a Synergy/DE Client installation, backup_mode is returned with a value of 4 (disabled), regardless of the backup mode on the shared machine.

See also