Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > SET_SYNC

SET_SYNC

Script Function: Executes the defined action of a Sync object.

Syntax

SET_SYNC(Sync, Action)

Syntax

Description/Format

Sync

Name of the Sync object whose action should be executed.
Format: AE name, script literal or script variable

Action

Action that should be executed.
Format: AE name, script literal or script variable


Return codes

"Y" - Sync action could be executed .
"N" - Sync action could not be executed.

Comments

You can define actions concerning a Sync object in the Sync tab.

Whether or not an action can be executed depends on the specified definitions because each action can only be executed if there is a particular condition.

Note that write access (W) to the specified Sync object is required in order to execute this script element.

Example

:SET &RET#=SET_SYNC("DB.STATUS","EXCLUSIVE")
:
IF &RET# = "Y"
:   
PRINT "Sync condition EXCLUSIVE was set!"
:
ELSE
:   
PRINT "Sync condition EXCLUSIVE was not set!"
:
ENDIF

 

See also:

Script element Description

GET_SYNC

Queries the current condition or value of a Sync object.
:ATTACH_SYNC Assigns a Sync object to a task.

Script Elements - Read or Modify Objects

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by function