.\"##
.\" $XConsortium: p027,v 5.2 94/04/17 20:54:30 rws Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "CREATE STORE" 3P "29 February 1991"
.SH NAME
CREATE STORE \- creates a Store, and returns a handle to it
.IX "CREATE STORE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pcreate_store ( err, store )
Pint	*err;	\fIOUT Error\fR
Pstore	*store;	\fIOUT Handle to store object\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2CREATE STORE\s+2 creates a Store object and returns the handle to it.
Store objects are used to hold the return values of complex inquiry
functions.
.SS C Output Parameter
.IP \fIerr\fP
The status of the creation of the new Store.
.IP \fIstore \fP
The handle to the newly created Store.
.SS Execution
\s-2CREATE STORE\s+2 creates a new Store and returns a handle to it
via the \fIstore\fR parameter.
The parameter \fIerr\fR returns the error number of any error detected.
If a zero is returned the creation was successful.
.LP
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 \s-2DELETE STORE\s+2, or until the Store is used as
an argument to a subsequent inquiry function, in which case the information
is overwritten.
.SH ERRORS
900
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "DELETE STORE (3P)"
.fi
