GET STRING(3P) — SUNPHIGS LIBRARY

NAME

GET STRING− retrieve the STRING measure from the PHIGS current event report

SYNOPSIS

C Syntax

void
pgetstring ( string )
Pchar∗string;OUT string

FORTRAN Syntax

SUBROUTINE pgtst ( LOSTR, STR )
INTEGERLOSTROUT number of characters returned
CHARACTER∗(∗)STR OUT string

FORTRAN Subset Syntax

SUBROUTINE pgtst(LOSTR, STR)
INTEGER LOSTROUT number of characters returned
CHARACTER∗80 STROUT string

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use GET STRING to retrieve the measure (logical input value) of the STRING device from the current event report in the PHIGS state list.

A STRING device measure consists of a character string.

C Output Parameter

stringA pointer to a Pchar array in which to store the STRING measure. The string is null terminated. 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. Pchar is defined in phigs.h as

typedef charPchar;

FORTRAN Output Parameters

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

The GET STRING function retrieves the measure of a STRING device from the current event report in the PHIGS state list.

When an input device that is set to EVENT mode is triggered by the operator, an event report is added to the input event queue. The event report contains the identity and current measure of the device. AWAIT EVENT moves the measure of the oldest event in the input queue to the current event report in the PHIGS state list. If the event was a STRING event, GET STRING is used to retrieve the measure from the current event report.

See INITIALIZE STRING 3 for a description of the available STRING devices and how their measure values are determined.

ERRORS

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

259Ignoring function, the input device class of the current input report does not match the class being requested

Museum