Omron SYSMAC FH Series User Manual page 686

SceneDescription$
Gets the scene description.
Format
SceneDescription$(<sceneNo>)
Parameter
Parameter
Data type
name
<sceneNo> Integer type
Return value
Returns the scene description as a character string.
Description
Gets the description set in the scene of the scene number specified in the <sceneNo> parameter.
If a description is not set, the null character string ("") is returned.
The scene description can be set in the maintenance screen or by executing the SetSceneDescription
function. (Reference:
If an incorrect data type is specified for a parameter, a "Type mismatch" error will occur.
If a non-existent number, numerical value, or combination of data types or values is specified for a parameter,
an "Illegal function call" error will occur.
If a value is assigned to the return value variable or the variable is not used in an expression, a "Syntax error"
error will occur.
If the format is written incorrectly, such as writing the macro function name incorrectly, omitting a comma, or
omitting a half-width space, a "Syntax error" error will occur.
Usage Cautions
• None.
Example
Gets the description of scene 1, and if a description is not set, setting the description.
Rem Get the scene description
DESCRIPTION$ = SceneDescription$(1)
If DESCRIPTION$ = "" Then
Rem Set the scene description
SetSceneDescription 1, "Description 1"
Endif
Useable Modules
Control Macro / Communication Command Macro
Supported Versions
Version 3.50 or later
684
Macro Reference
Scene number (0 to 127) of scene whose description is to be gotten.
SetSceneDescription (p.715)) (Reference:
WWW.NNC.IR
Description
Editing Scenes (p.62))
Vision System FH/FZ5 Series
User's Manual (Z340)