%SYN_SETSTATE

Set a Synergy state option

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

 

status = %SYN_SETSTATE(option)

or

xcall SYN_SETSTATE(option)

Return value

status

One of the following values: (n)

0 = Successful

1 = Not successful

Arguments

option

One of the following values: (n)

0

Suspend application execution on any attempt to DELETE, STORE, or WRITE to a Synergy ISAM file when backup mode is On. (default)

1

Signal an error on any attempt to DELETE, STORE, or WRITE to a Synergy ISAM file when backup mode is On.

Discussion

%SYN_SETSTATE enables you to alter the behavior of your application when update I/O is frozen because a backup is occurring. If the backup mode is On and option is 0, the application is suspended until the backup finishes. If the backup mode is On and option is 1, the runtime signals a “Backup mode is On” error ($ERR_BACKPEND) on any attempt to DELETE, STORE, or WRITE to a Synergy ISAM file.

On Windows, if the DBLDIR:synbackup.cfg file doesn’t exist, status is 0.

On UNIX, if the SYNBACKUP environment variable is not set, status is 0.

Note

The backup mode feature is not supported on systems running multiple versions of Synergy.

See also