NAME

GET STRING− retrieve the STRING event in the PHIGS current event report

SYNOPSIS

C Syntax

void
pget_string ( string )
char∗string;OUT pointer to string of bufsiz
for the device + 1 for the terminator

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

GET STRING retrieves the current event report from the PHIGS state list when the event report contains a STRING event.  A STRING event consists of an array of characters reflecting the contents of a STRING input device’s buffer when the event was generated. 

C Output Parameter

stringPHIGS copies the event’s contents to the array pointed to by string.  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. 

Execution

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

When an input device in EVENT mode is triggered by the operator, an event report is added to the input event queue if the queue is not full.  The event report contains the identity and current measure of the triggered device.  AWAIT EVENT moves the contents 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 contents of the event from the current event report. 

See INITIALIZE STRING 3 for a description of the available STRING devices and how events are generated from them. 

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

SEE ALSO

INITIALIZE STRING (3P)
INITIALIZE STRING 3 (3P)
AWAIT EVENT (3P)

September 02, 1992