• a5_clip_library Function
• a5_export_scripts_udfs Function
• a5_get_actionscript_xbasic Function
• a5_is_actionscript Function
• a5_is_scr_being_edited Function
• a5_new_script_w_prompt Function
• a5_prmpt_script_name Function
• a5_save_script Function
• a5_script_create_new Function
• a5_script_favorites Function
• a5_script_favorites_menu Function
• a5_script_rename Function
• a5_scripteditor_popup Function
• a5_scriptgenie_multistep Function
• a5_scriptgenie_multistp2 Function
• a5_select_script_action Function
• A5_SETUP_ASK_VARS Function
• a5_what_being_edited Function
• EXPORT_SCRIPTS_AND_UDF Function
• export_scripts_and_udfs Function
• export_scripts_udfs Function
• IMPORT_SCRIPTS_UDF Function
• import_scripts_udfs Function
• load_compiled_script Function
• LOAD_LIBRARY Function
• ON_CONDITION Function
• script_drop Function
• script_exists Function
• SCRIPT_LOAD Function
• script_load_compiled Function
• SCRIPT_PLAY Function
• SCRIPT_PLAY_LOCAL Function
• script_rename Function
• script_save Function
• SCRIPT_SCHEDULE Function
• SCRIPT_SCHEDULE_NAME_GET Function
• SCRIPT_SCHEDULE_TIME_GET Function
• SCRIPT_SPAWN Function
• SCRIPTEDITOR_OPEN Function
• SLEEP Function
• UDF_LOAD Function
• VARIABLES_ENUM Function
• WAIT_UNTIL Function
• XBASIC_ASYNCHRONOUS Function
• XBASIC_SYNCHRONOUS Function
• XBASIC_WAIT_FOR_IDLE Function

SCRIPT_PLAY Function

Syntax

Arguments

script_nameCharacter

The name of a script or function. The Script_Name parameter can include an optional library name if you which to specify a script that is in a different database (.alb file), or is in a dictionary of a table or set that is not attached to the current database.

Description

Returns TRUE if script was played.

Discussion

The SCRIPT_PLAY() function runs a Global Script. Returns TRUE (.T.) if the script was played. The Script_Name parameter must match the script name exactly and is case-sensitive.

The Script_Name parameter can include an optional library name if you which to specify a script that is in a different database (.ALB file), or is in a dictionary of a table or set that is not attached to the current database.

For example to play a script called "Message1" that is in the "Scripts" database, you would type:

script_play("Message1@d:\alpha5\scripts.alb")

The execution of the current script is interrupted when SCRIPT_PLAY() begins, and resumes at the point of interruption after the called script finishes. Any Xbasic statements that occur after SCRIPT_PLAY() are executed.

The SCRIPT_PLAY() command plays the script in the current session. To play a script in a new session, use the SCRIPT_SPAWN()command.

Example

This script plays the script Hello in the current database.

script_ran = script_play("Hello")

This script plays the script 'Goodbye' in the data dictionary C:\ALPHA5\TEST.DDD.

script_ran = script_play("Goodbye@C:\ALPHA5\TEST.DDD")

Limitations

Desktop applications only.

See Also

• Script Functions