Index Page
dskcls_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 dskcls_c ( SpiceInt      handle,
                   SpiceBoolean  optmiz ) 

Abstract

 
   Close a DSK file. 
 

Required_Reading

 
   DAS 
   DSK 
 

Keywords

 
   DAS 
   DSK 
   FILES 
   TOPOGRAPHY


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 will be  
      diagnosed by routines 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. 
  
         dskcls_c ( HANDLE, SPICETRUE ) 
 
   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. 
 
         dskcls_c ( HANDLE, SPICETRUE ) 
 
   3) Close an existing DSK file that had been opened 
      for read access. In this case `optmiz' is ignored: 
  
         dskcls_c ( HANDLE, SPICEFALSE ) 
 
      or 
 
         dskcls_c ( HANDLE, SPICETRUE ) 
    

Restrictions

 
   1) This routine should not be called by user applications 
      that have loaded a DSK file via furnsh_c. Such applications 
      should call the functions unload_c or kclear_c instead. 
 

Literature_References

 
   None. 
 

Author_and_Institution

 
   N.J. Bachman    (JPL) 
 

Version

 
   -CSPICE Version 1.0.0, 23-JAN-2016 (NJB)

Index_Entries

 
   close a dsk file 
 
Wed Apr  5 17:54:32 2017