|
WSupported on Windows
|
USupported on Unix
|
|
NSupported in Synergy .NET
|
status = %SYN_SETSTATE(option)
or
xcall SYN_SETSTATE(option)
Return value
status
Returns 0 if successful or 1 if not successful. (n)
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 C:\ProgramData\Synergex\SynergyDE\dbl\synbackup.cfg file doesn’t exist, status is 0.
On Unix, if the SYNBACKUP environment variable is not set, status is 0.
|
The backup mode feature is not supported on systems running multiple versions of Synergy. |
See also
- %SYN_GETSTATE routine
- SYNBACKUP environment variable
- synbackup utility
