dafcls_c

Index Page dafcls_c
A B C D E F G H I J K L M N O P Q R S T U V W X
Procedure Abstract Required_Reading Keywords Brief_I/O Detailed_Input | Detailed_Output Parameters Exceptions Files Particulars Examples | Restrictions Literature_References Author_and_Institution Version Index_Entries
#### Procedure
       void dafcls_c ( SpiceInt handle )
#### Abstract
       Close the DAF associated with a given handle.
#### Required_Reading
       DAF
#### Keywords
       DAF
       FILES
#### Brief_I/O
       Variable  I/O  Description
       --------  ---  --------------------------------------------------
       handle     I   Handle of DAF to be closed.
#### Detailed_Input
       handle      is the file handle of a previously opened DAF file.
#### Detailed_Output
       None.
#### Parameters
        None.
#### Exceptions
       1) If the specified handle is not known to the DAF subsystem
          (because it does not belong to a file opened via the DAF
          API), nothing happens.

       2) If this routine is used to close a file whose handle is
          known to the DAF subsystem, and if the file handle is
          attached to a non-DAF file, routines called by this
          routine signal an error.
#### Files
       None.
#### Particulars
       Because the DAF subsystem must keep track of what files are open at
       any given time, it is important that DAF files be closed only with
       dafcls_c, to prevent the remaining DAF routines from failing,
       sometimes mysteriously.

       Note that when a file is opened more than once for read access,
       dafopr_c returns the same handle each time it is re-opened.
       Each time the file is closed, dafcls_c checks to see if any other
       claims on the file are still active before physically closing
       the file.
#### Examples
       In the following code fragment, the arrays in a file are examined in
       order to determine whether the file contains any arrays whose names
       begin with the word TEST. The complete names for these arrays are
       printed to the screen. The file is closed at the end of the search.

          #include "SpiceUsr.h"
              .
              .
              .
          dafopr_c ( fname, &handle );
          dafbfs_c ( handle );
          daffna_c ( &found );

          while ( found )
          {
             dafgn_c ( name );

             if (  strncmp( name, "TEST", 4 ) == 0  )
             {
                printf ( "%s\n", name );
             }
             daffna_c ( &found );
          }

          dafcls_c ( handle );

       Note that if the file has been opened already by a DAF routine
       at some other place in the calling program, it remains open.
       This makes it possible to examine files that have been opened for
       use by other modules without interfering with the operation of
       those routines.
#### Restrictions
       None.
#### Literature_References
       NAIF Document 167.0, "Double Precision Array Files (DAF)
       Specification and User's Guide"
#### Author_and_Institution
       N.J. Bachman    (JPL)
       K.R. Gehringer  (JPL)
       W.L. Taber      (JPL)
       I.M. Underwood  (JPL)
#### Version
       -CSPICE Version 1.0.1, 28-JAN-2004 (NJB)

          Header update:  the exceptions section now lists the
          case of attempting to close a non-DAF file using this
          routine.

       -CSPICE Version 1.0.0, 01-AUG-1999 (NJB) (KRG) (WLT) (IMU)
#### Index_Entries
       close daf
#### Link to routine dafcls_c source file dafcls_c.c

    Thu Apr 16 08:57:37 2009