[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPSSTH - Set Structure Store Threshold

GPSSTH (ssid, threshold)

Purpose

Use GPSSTH to specify a storage threshold for a structure store. This threshold represents the size (in bytes) of the structure store.

When the amount of storage allocated to the specific structure store exceeds the specified storage threshold, the graPHIGS API generates a Threshold Exceeded event and sends it to all application processes attached to the structure store. If the size of the structure store already exceeds the threshold value at the time the threshold value is set, then the graPHIGS API generates the event immediately. Once the event is generated, no further events are generated until your application calls GPSSTH again (by any application process attached to the structure store)

Each structure store has only one threshold value that your application can set. If your application sets a structure store threshold value, then that value overrides any other threshold that may have been set. For information on Threshold Events, see The graPHIGS Programming Interface: Technical Reference

Parameters

ssid -- specified by user, fullword integer

Structure store identifier.

threshold -- specified by user, fullword integer

Structure store threshold value in bytes (>=0)

Error Codes

222
SPECIFIED STRUCTURE STORE DOES NOT EXIST
225
STRUCTURE STORE THRESHOLD SIZE < ZERO

Related Subroutines

GPAWEV
Await Event
GPEHND
Define Error Handling Subroutine
GPEVHN
Define Event Handling Subroutine
GPQNCS
Inquire Available Nucleus Storage Size

RCP code

201331461 (X'0C001305')


[ Previous | Next | Contents | Glossary | Home | Search ]