OPTIONS

Specify runtime options

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
OPTIONS:"runtime_option[, …]"

Arguments

runtime_option

An expression, in quotation marks, that contains one or more of the following options separated by commas: (a)

/bufstore

Enable buffering of a set of successive stored records with no intervening READ, READS, FIND, DELETE, or WRITE statements. This option works on ISAM files stored on the client when xfServer is being used and when system option #36 is not set. (If system option #36 is set, or if the file is not an ISAM file, /bufstore is ignored.) The buffer size is the value of the SCSPREFETCH environment variable if it is set, or 4K if SCSPREFETCH is not set. See SCSPREFETCH for more information. (Windows and UNIX only)

/encrypt

Specify that a client application should request data packet encryption from the server if the server is enabled with “slave” encryption. If the file is not a remote file via xfServer, this option is ignored. (It is also ignored if master encryption is enabled on the server, because all data is encrypted anyway.) See Using client/server encryption for more information.

/ex

Specify exclusive access for the file being opened.

/fl=length

Define the record format as fixed‑length with length as the specified record size.

/io=mode[:submode]

Redefine the OPEN processing mode, where mode is the I/O mode and submode is the I/O submode in which you want to open the file. This option overrides the OPEN mode specified. The options /io=O and
/io=A open a file for exclusive access, equivalent to the compile‑time output and append modes.

/nl

Specify no record locking is to be performed on the file being opened.

/si=size

Set the initial allocation size of the file to size. (OpenVMS only)

/scl=level

Allow an xfServer client to specify the security compliance level, which defines which protocols will be used when encryption is enabled. Valid values for level are 0 (use whatever the current Synergy default is, which could change when you upgrade to a new version of Synergy), 1 (use TLS 1.0, 1.1, and 1.2 protocols, which is the default in 10.3.1b), or 2 (use TLS 1.1 and1.2 protocols). SSLv3 and lower protocols are not supported.

/share=value

See SHARE.

/sequential

Optimize sequential record access. On Synergy ISAM, this option optimizes sequential read performance by not doing a tree probe for each sequential record. On an active file (one with concurrent updates occurring), some adjacent records may not be seen at all by a READS without an intervening READ statement. In versions prior to 6.1, this was the default behavior.

/stream

Specify that the file type is stream when opened for output on an OpenVMS server system.

/tf=filename

See TEMPFILE.

/guiwnd

See GUIWND. (Windows only)

/cache

Ignored as of Synergy/DE 10, because all systems implicitly cache the index. In earlier versions, /cache opens an ISAM file with cached access. See option #3 for details. (Windows, UNIX only)

/po

Specify the start position. See POSITION. (Windows, UNIX only)

/nodelay

Open a serial device with the UNIX O_NDELAY option. This causes the OPEN to not be blocked until the device is ready or available. The O_NDELAY flag is turned off after the device is opened so that I/O to the device does not automatically generate a “Failure during I/O operation” error ($ERR_IOFAIL). (UNIX only)

/alloc=value

See ALLOC. (OpenVMS only)

/bufnum=value

See BUFNUM. (OpenVMS only)

/bufsiz=value

See BUFSIZ. (OpenVMS only)

/deq=value

See DEQ. (OpenVMS only)

/rectype=value

See RECTYPE. (OpenVMS only)

Discussion

The OPTIONS qualifier enables you to specify one or more runtime options. These runtime options are evaluated when the OPEN is processed during program execution. Each runtime option must be enclosed in quotation marks.

The runtime options set by the OPTIONS qualifier take precedence over the other I/O qualifiers.

See also

OPEN.

Examples

open(chn, o, "fred", OPTIONS:"/stream")