.\"
.\" $XConsortium: p040,v 5.2 94/04/17 20:54:40 rws Exp $
.\"
.\" 
$XMCOPY
.\" Copyright (c) 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
.\" 
.\"                         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 names of Sun Microsystems,
.\" and the X Consortium 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 "EMPTY STRUCTURE" 3P "29 February 1991"
.SH NAME
EMPTY STRUCTURE \- remove all elements from structure
.IX "Structures" "EMPTY STRUCTURE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pempty_struct ( struct_id )
Pint	struct_id;	\fIstructure id\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2EMPTY STRUCTURE\s+2 to remove all the structure elements from a specified structure. The structure continues to exist as an empty structure even if there are no references to it in other structures. Any references that do exist are not changed by the \s-2EMPTY STRUCTURE\s+2 subroutine.
.SS C Input Parameter
.IP \fIstruct_id \fP
Specifies the structure from which all structure elements should be removed.
.SS Execution
The \s-2EMPTY STRUCTURE\s+2 subroutine removes all the structure elements from structure identifier.  The structure specified may be the open structure, another existing structure, or a non-existent structure.
.sp
If structure identifier is the currently open structure or an existing structure, \s-2EMPTY STRUCTURE\s+2 removes all elements from the structure and sets the element pointer to 0. Any references to this structure in other structures are not changed.
.sp
If the structure specified by structure identifier does not exist, \s-2EMPTY STRUCTURE\s+2 creates a new empty structure.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "DELETE ELEMENT RANGE (3P)"
.SM "DELETE ELEMENTS BETWEEN LABELS (3P)"
.SM "DELETE STRUCTURE (3P)"
.fi
