NAME

CREATE STORE − creates a Store, and returns a handle to it

SYNOPSIS

C Syntax

void
pcreate_store ( err, store )
Pint∗err;OUT Error
Pstore∗store;OUT Handle to store object

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

CREATE STORE creates a Store object and returns the handle to it.  Store objects are used to hold the return values of complex inquiry functions. 

C Output Parameter

errThe status of the creation of the new Store. 

store
The handle to the newly created Store.

Execution

CREATE STORE creates a new Store and returns a handle to it via the store parameter.  The parameter err returns the error number of any error detected.  If a zero is returned the creation was successful. 

A Store is an opaque pointer that is passed as a parameter to a function returning complex data.  A Store contains the memory to hold the results of a complex inquiry.  A Store may be passed to or used by more than one inquiry function, but at any one time a Store only holds the result of the last inquiry function that used it as an argument.  A Store continues to hold the information from the last inquiry function until it is freed by DELETE STORE, or until the Store is used as an argument to a subsequent inquiry function, in which case the information is overwritten. 

ERRORS

900

SEE ALSO

DELETE STORE (3P)

September 02, 1992