.\"
.\" $XConsortium: p089,v 5.2 94/04/17 20:55:21 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 "INQUIRE ARCHIVE FILES" 3P "29 February 1991"
.SH NAME
INQUIRE ARCHIVE FILES \- inquire the currently open archive file identifiers and names
.IX "Archive Files" "INQUIRE ARCHIVE FILES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_ar_files ( store, error_ind, ar_files )
Pstore	store;	\fIhandle to Store object\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Par_file_list	**ar_files;	\fI\s-2OUT\s+2 list of archive file\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE ARCHIVE FILES\s+2 to determine the names and identifiers of
all currently open archive files.
.SS C Input Parameters
Applications using the \s-2C\s+2 binding must create a buffer to be used by this
function as memory space for storing data associated with the device state.
This buffer is passed as the \fIstore\fP argument.  
.LP
The store buffer is a data area managed by \s-2PHIGS\s+2. While the application 
is responsible for creating the inital buffer through a call to \s-2\CREATE STORE\s+2, 
\s-2PHIGS\s+2 manages this area such that there is sufficient memory for the 
specific inquiry. The data record within the store buffer is accessed 
by the pointer pointed to by \fIar_files\fR.
.IP \fIstore\fP
The memory buffer \s-2PHIGS\s+2 is to use for storing the information
returned.  
This buffer must exist prior to calling this function (see
\s-2CREATE STORE (3P)\s+2).
.SS C Output Parameters
.IP \fIerror_ind\fP
A pointer to the location to store the error number of any error detected
by this function.
.IP \fIar_files\fP
A pointer to a structure Par_file_list,
containing a list of the currently open archive file identifiers and names.
Par_file_list is defined in phigs.h as follows:
.sp .4
.ta .5i +1.0i +1.0i
.nf
typedef struct{
.sp .2
	Pint	num_ar_files;	/* number of archive files */
	Par_file	*ar_files;	/* list of archive files */
.sp .2
} Par_file_list;
.fi
The \fInum_ar_files\fP component specifies the number of currently open archive files.
The \fIar_files\fP component is a pointer to a list, \fInum_ar_files\fP long,
of Par_file structs listing the identifiers and names of currently open archive files.
Par_file is defined in phigs.h as follows:
.sp .4
.ta .5i +1.0i +1.0i
.nf
typedef struct{
.sp .2
	Pint	id;	/* archive file identifier */
	char	*name;	/* archive file name */
.sp .2
} Par_file;
.fi
The \fIid\fP component is the archive file identifier and the \fIname\fP component
is a pointer to a character string giving the file name of the archive file with 
identifier \fIid\fP.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "OPEN ARCHIVE FILE (3P)"
.SM "CLOSE ARCHIVE FILE (3P)"
.SM "INQUIRE ARCHIVE STATE VALUE (3P)"
.SM "CREATE STORE (3P)"
.SM "DELETE STORE (3P)"
.fi
