GET_SYNC

Use the GET_SYNC script function to retrieve the current settings of a Sync object. You can find these settings in the Attributes page of the object as well.

Syntax

GET_SYNC (Sync, Type)

Parameters

Parameter	Description	Format	Allowed Values
Sync	The name of the Sync object whose current condition or value should be retrieved.	AE name, script literal, or script variable	n.a.
Type	Defines whether the current condition or the current value should be determined.	AE name, script literal, or script variable	STATE: Current condition. VALUE: Current value.

Return Codes

This script function returns the following values:

The current condition of the Sync object.
The current value of the Sync object.

Examples

:SET &ADMIN# = GET_SYNC("DB.STATE", "STATE")

:IF &ADMIN# = "EXCLUSIVE"

:PRINT "The administrator job is currently exclusively using the database."

:ENDIF

:SET &RET# = GET_SYNC("DB.STATE", "VALUE")

:IF &RET# = 0

:PRINT "No job is currently using the database."

:ELSE

:PRINT "&RET# jobs are currently using the database."

:ENDIF