SAMPLE STRING(3P) — SUNPHIGS LIBRARY

NAME

SAMPLE STRING − sample current measure of a string device

SYNOPSIS

C Syntax

void
psamplestring ( ws, dev, string )
Pintws;workstation identifier
Pintdev;string device number
Pchar∗string;OUT string

FORTRAN Syntax

SUBROUTINE psmst ( WKID, STDNR, LOSTR, STR )
INTEGERWKIDworkstation identifier
INTEGERSTDNRstring device number
INTEGERLOSTROUT number of characters returned
CHARACTER∗(∗)STR OUT string

FORTRAN Subset Syntax

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use SAMPLE STRING to sample the current measure of the specified string device without waiting for the device trigger to fire. The device must be in SAMPLE mode. See SET STRING MODE and INITIALIZE STRING for more information.

C Input Parameters

wsWorkstation identifier. An integer specifying the workstation with which the specified string device is associated.

devThe device number of the string device to be sampled. See the Available Devices section of INITIALIZE STRING for a description of the available devices.

stringA pointer to a Pchar array in which to store the STRING measure. The string is null terminated. The array should be at least as large as the buffer of the STRING device. This buffer size is set when the device is initialized.

FORTRAN Input Parameters

WKIDThe workstation identifier of the workstation associated with the device.

STDNR
The device number of the STRING device. See the Available Devices section of INITIALIZE STRING for a description of the available devices.

LOSTR
The number of characters returned in STR.

STRAn array in which to store the STRING measure. The array must be at least as large as the buffer of the STRING device that generated the event. This buffer size is set when the device is initialized.

The FORTRAN subset version of this function will return no more than 80 of the characters in the measure.

Execution

SAMPLE STRING samples the specified string device. The device must be in SAMPLE mode. See SET STRING MODE and INITIALIZE STRING for more information.

When a device is set to SAMPLE mode, a measure process is created for the device and the device is activated. When SAMPLE STRING is called, the current value of the measure process for the specified device is retrieved without waiting for the device’s trigger to fire.

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

061Ignoring function, specified workstation is neither of category INPUT nor of category OUTIN

250Ignoring function, the specified device is not available on the specified workstation

252Ignoring function, the function requires the input device to be in SAMPLE Mode

Museum