SAMPLE STRING(3P) — Kubota Pacfic Computer Inc. (29 February 1991)
NAME
SAMPLE STRING − sample current measure of a string device
SYNOPSIS
C Syntax
void
psample_string ( ws, dev, string )
Pintws;workstation identifier
Pintdev;string device number
char∗string;OUT string
Required PHIGS Operating States
(PHOP, WSOP, ∗, ∗)
DESCRIPTION
Purpose
Use SAMPLE STRING to sample the current measure of the specified string device without waiting for input from the operator. 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.
C Output Parameter
stringA pointer to a character 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.
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 further input from the operator.
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
SEE ALSO
SET STRING MODE (3P)
INITIALIZE STRING 3 (3P)
REQUEST STRING (3P)
GET STRING (3P)
INQUIRE STRING DEVICE STATE (3P)
September 02, 1992