Procedure

     DSKCLS ( DSK, close file )

     SUBROUTINE DSKCLS ( HANDLE, OPTMIZ )

Abstract

     Close a DSK file.

Required_Reading

     DAS
     DSK

Keywords

     DAS
     DSK
     FILES

Declarations

     IMPLICIT NONE

     INCLUDE 'dla.inc'

     INTEGER               HANDLE
     LOGICAL               OPTMIZ

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     HANDLE     I   Handle assigned to the opened DSK file.
     OPTMIZ     I   Flag indicating whether to segregate the DSK.

Detailed_Input

     HANDLE   is the DAS file handle associated with the file.
              The file may be open for read or write access.

     OPTMIZ   is a logical flag indicating whether the DSK
              should be segregated before it is closed. This
              option applies only to files open for write
              access. The value of OPTMIZ has no effect for
              files opened for read access.

              See the DAS Required Reading das.req for a
              discussion of segregation of DAS files.

Detailed_Output

     None. This routine operates by side effects.

Parameters

     None.

Exceptions

     1)  If an error occurs when the file is closed, the error is
         signaled by a routine in the call tree of this routine.

Files

     See argument HANDLE.

Particulars

     This routine provides a DSK-level interface for closing DSK files.

     In cases where DSKs opened for write access are to be closed
     without segregation, this interface is slightly simpler than that
     available at the DAS level.

Examples

     1) Close a new DSK file using DAS segregation. HANDLE
        is the DAS file handle of the DSK.

        This is the normal choice for DSK creation.

           CALL DSKCLS ( HANDLE, .TRUE. )

     2) Close a new DSK file without using DAS segregation. The
        close operation will be fast, but reading the file will be
        less efficient than if the file had been segregated.

           CALL DSKCLS ( HANDLE, .TRUE. )

     3) Close an existing DSK file that had been opened
        for read access. In this case OPTMIZ is ignored:

           CALL DSKCLS ( HANDLE, .FALSE. )

        or

           CALL DSKCLS ( HANDLE, .TRUE. )

Restrictions

     1)  This routine should not be called by user applications
         that have loaded a DSK file via FURNSH. Such applications
         should call the KEEPER entry points UNLOAD or KCLEAR instead.

Literature_References

     None.

Author_and_Institution

     N.J. Bachman       (JPL)
     J. Diaz del Rio    (ODC Space)

Version

    SPICELIB Version 1.1.0, 12-OCT-2021 (JDR) (NJB)

        Bug fix: now calls FAILED after call to DASHAM.
     
        Edited the header to comply with NAIF standard.

    SPICELIB Version 1.0.0, 08-FEB-2017 (NJB)


        09-OCT-2009 (NJB)

           Updated header.

        20-OCT-2006 (NJB)

           Original DSKLIB version.