S -- Logic Commands

SendListDynamic

Populates a dynamic list box with a single value-description pair. To populate a list box with several values, use the SendListDynamic logic command multiple times. It is intended for use with the Component Enabler or the NOF interface.

SENDLISTDYNAMIC expression variable
Option Description

expression

The name of the listbox to download.

This name is restricted to a maximum length of 23, and must be in one of the following forms (where <item> is the variable the list box applies to); <ispec>.<item> (indicates that the list box applies only to users of the specified ispec), or *.<item> (indicates that the list box applies to users of all ispecs).

variable

A string expression returning the value-description pair to download.

SendListStatic

Populates a static list box with multiple value-description pairs from a specified file.

SENDLISTSTATIC expression { <download_file> | FILE extract_file }
 
<download_file> := { file_name | expression }[ ON expression ]
Option Description

expression

The name of the listbox to download.

This name is restricted to a maximum length of 23, and must be in one of the following forms (where <item> is the variable the list box applies to); <ispec>.<item> (indicates that the list box applies only to users of the specified ispec), or *.<item> (indicates that the list box applies to users of all ispecs).

download_file

The name of the file to download. This file contains the list box data.

ON expression

This command option is not supported on applications deployed to Windows.

 FILE extract_file

Specifies the existing extract file to use as a definition. This extract file must have been previously referenced using a Determine Actual or Extract logic statement with the RetainAs command option, or referenced by a SetTitle logic statement in the report.

SendMessage

Sends messages directly to the status line of specified user terminals signed on to the runtime application. In reports, the message is sent to the report message window. The message is sent immediately, and does not wait for the end of the current transaction.

SENDMESSAGE { ALL | ODT | variable } expression
Option Description

variable

Sends the message to this specified user.

To send the message to the current user, specify Glb.Stn.

To send the message to the initiating user, specify Glb.InitStn.

ALL

Sends a broadcast message.

ODT

Sends the message to the Windows Event Log on the server.

expression

The text of the message, which can be a numeric value. If a numeric value is used, it is converted to text.

This message is limited to a maximum lengt of 50 characters.

Note: For Windows-based systems, the SendMessage ODT command accepts a message of more than 50 characters and logs it to Windows Event Log as expected.

SendPrint

Outputs a report to multiple destinations.

SENDPRINT [ AS report_name ] device [ expression ] [ AT expression ]
Option Description

AS report_name

Indicates the report is an outputstream with a different name, specified by the qualifier.

device

The device to direct output to, which can be one of EX, LP, RP, TP, or VD.

expression

The name of the destination output device.

This is only an optional parameter if the LP device type is specified. It is a required parameter if one of the TP, VD, or EX device types are specified.

AT expression

This command option is not supported on applications deployed to Windows.

SetDB

The SetDB logic command is not supported on applications deployed to MCP or Windows.

SETDB database_name { class_name | ALL }
Option Description

database_name

A variable or literal (in quotes) that specifies the target database.

class_name

Name of a persistent class to use the specified target database.

ALL

Specifies that all classes are to have the same target database.

SetTitle

Changes the name of a report extract file during the running of the report.

SETTITLE extract_file expression [ PACK expression ] [ EXIST ]
Option Description

extract_file

The extract file to name.

expression

The name to assign to the extract file. This can be any valid path up to 100 characters in length, the file name portion of which can be up to 14 characters in length.

For applications that run on Windows, if this is an absolute path, it overrides the path specified for the extract pack. To use the specified extract pack, this path should be relative to the extract pack path.

Note: Filenames defined within string literals must have backslash characters escaped by a backslash. For example, “C:\\Folder\\File.dat”. Refer to String Literals for more information.

If the extract file is to go to TAPE, this should be the path to the tape drive.

PACK expression

This command option is not supported on applications deployed to Windows.

EXIST

Treats the extract file as an Existing extract file.

Sleep

Commits any current database transaction and suspends execution of a report. When reactivated, execution resumes from the next logic statement in the method.

SLEEP { expression | UNTIL { WAKEUP | WOKEN } ENDAFTER expression } [NOCOMMIT]
Option Description

expression

Specifies the time to suspend the report. Time can be specified as number of seconds, as an attribute with numeric value ranging from 0 through 9999, or any numeric expression. The report is suspended until explicitly reactivated using a Wake logic statement, or the specified number of seconds has elapsed.

UNTIL (WAKEUP OR WOKEN)

Suspends the report until explicitly reactivated using a Wake logic statement, or termination of the report. It is equivalent to the Sleep 60 logic command variant.

ENDAFTER expression

Suspends the report until explicitly reactivated using a Wake logic statement, or termination of the report, or until the number of seconds (in the range 0 through 9999) specified has elapsed.

NOCOMMIT

Used in conjunction with OLTP global transaction processing (that is, with two-phase commit). The global transaction is not committed and completed. Any locked resources remain locked both during and after this Sleep logic statement.

This command option is restricted to OLTP applications.

Start

Starts a program or batch file (.exe, .com. or .bat files). The program or file is started immediately in the background.

START expression [ expression ]
Option Description

expression (first)

The program or .bat file to execute. This can be a text or numeric value. If a numeric value is used, it is converted to text.

expression (second)

A command line argument. This can be a text or numeric value. If a numeric value is used, it is converted to text.

Note: For an MCP Platform, timeout for LSS to respond to a START and RUN request is now configurable through the use of the MAXWAIT task attribute associated with the LINCSUPPORT library. When the wait time has exceeded the value set or up to the current default of 60 seconds, GLB.STATUS is set to TOUT meaning timeout.

StnInfo

Obtains information about a username in the LINCIINET file or a ROC alias.

STNINFO expression variable
OptionDescription

expression

The Windows username or ROC alias

variable

An string variable to receive the requested information. This variable must have a minimum length of 79.

Subtract

Subtracts the value of a numeric expression from the value of a number-primitive variable and stores the result in that variable, or optionally in a specified result variable.

SUBTRACT expression variable [ GIVING variable ] [ ROUNDED ] [ GS status ]
Option Description

expression variable

The numeric expression to subtract from the qualifier. The qualifier also receives the result if the Giving command option is not specified. If the Giving option is specified then qualifier might be replaced by an expression.

(GIVING or GIV) variable

Directs the result to the specified qualifier.

(ROUNDED or ROU)

Rounds the result when truncation occurs.

GS status

Indicates arithmetic overflow using the specified variable.

SwitchTo

Programmatically switches from the current application to another application at runtime.

SWITCHTO expression [ DATA expression ]
[ PARTITION expression ] [ BYE ] [ CLEAR ] [ INHERIT ]
Option Description

expression

The name of the generated target application.

If it is an invalid application name, and the Bye command option is not specified, the current user interface of the originating application is displayed with a message about the unavailability of the target application.

If it is an invalid application name, and the Bye command option is specified, the user is logged off from the originating application.

(DATA or DA) expression

Specifies an expression to pass to the target application.

This expression is limited to a maximum length of 1850 characters.

(PARTITION or PA) expression

Specifies the partition name for Component Enabler.

This name is limited to a maximum length of 19 characters.

If the Partition command option is executed on a terminal that is not using Component Enabler, the command option is ignored.

BYE

Log off from the originating application.

CLEAR or CL

This command option is not supported on applications deployed to Windows.

INHERIT or IN

This command option is not supported on applications deployed to Windows.