NAME

INQUIRE ARCHIVE FILES − inquire the currently open archive file identifiers and names

SYNOPSIS

C Syntax

void
pinq_ar_files ( store, error_ind, ar_files )
Pstorestore;handle to Store object
Pint∗error_ind;OUT error indicator
Par_file_list∗∗ar_files;OUT list of archive file

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE ARCHIVE FILES to determine the names and identifiers of all currently open archive files. 

C Input Parameters

Applications using the C 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 store argument. 

The store buffer is a data area managed by PHIGS. While the application is responsible for creating the inital buffer through a call to CREATE STORE, PHIGS 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 ar_files. 

storeThe memory buffer PHIGS is to use for storing the information returned.  This buffer must exist prior to calling this function (see CREATE STORE (3P)). 

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

ar_files
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:

typedef struct{
Pintnum_ar_files; /∗ number of archive files ∗/
Par_file∗ar_files;/∗ list of archive files ∗/
} Par_file_list;

The num_ar_files component specifies the number of currently open archive files.  The ar_files component is a pointer to a list, num_ar_files long, of Par_file structs listing the identifiers and names of currently open archive files.  Par_file is defined in phigs.h as follows:

typedef struct{
Pintid;/∗ archive file identifier ∗/
char∗name;/∗ archive file name ∗/
} Par_file;

The id component is the archive file identifier and the name component is a pointer to a character string giving the file name of the archive file with identifier id. 

ERRORS

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

SEE ALSO

OPEN ARCHIVE FILE (3P)
CLOSE ARCHIVE FILE (3P)
INQUIRE ARCHIVE STATE VALUE (3P)
CREATE STORE (3P)
DELETE STORE (3P)

September 02, 1992