Index Page
spkopn_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 spkopn_c ( ConstSpiceChar * name,
                   ConstSpiceChar * ifname,
                   SpiceInt         ncomch,
                   SpiceInt       * handle  ) 

Abstract

 
   Create a new SPK file, returning the handle of the opened file. 
 

Required_Reading

 
   SPK 
 

Keywords

 
   SPK 
 

Brief_I/O

 
   VARIABLE  I/O  DESCRIPTION 
   --------  ---  -------------------------------------------------- 
   name       I   The name of the new SPK file to be created. 
   ifname     I   The internal filename for the SPK file. 
   ncomch     I   The number of characters to reserve for comments. 
   handle     O   The handle of the opened SPK file. 
 

Detailed_Input

 
   name     The name of the new SPK file to be created. 
 
   ifname   The internal filename for the SPK file that is being 
            created. The internal filename may be up to 60 characters 
            long. If you do not have any conventions for tagging your 
            files, an internal filename of "SPK_file" is perfectly 
            acceptable. You may also leave it blank if you like. 
 
   ncomch   This is the space, measured in characters, to be 
            initially set aside for the comment area when a new SPK 
            file is opened. The amount of space actually set aside 
            may be greater than the amount requested, due to the 
            manner in which comment records are allocated in an SPK 
            file. However, the amount of space set aside for comments 
            will always be at least the amount that was requested. 
 
            The value of ncomch should be greater than or equal to 
            zero, i.e., 0 <= ncomch. A negative value, should one 
            occur, will be assumed to be zero. 
 

Detailed_Output

 
   handle   The handle of the opened SPK file. If an error occurs 
            when opening the file, the value of this variable should 
            not be used, as it will not represent a valid handle. 
 

Parameters

 
   None. 
 

Exceptions

 
   1) If the value of ncomch is negative, a value of zero (0) will 
      be used for the number of comment characters to be set aside 
      for comments. 
 
   2) If an error occurs while attempting to open a CK file, the 
      value of handle will not represent a valid file handle. 
 
   3) If any input string pointers are null, the error 
      SPICE(NULLPOINTER) will be signaled.
      
   4) If any input strings have length zero, the error 
      SPICE(EMPTYSTRING) will be signaled.
 

Files

 
   See arguments name and handle. 
 

Particulars

 
   Open a new SPK file, reserving room for comments if requested. 
 

Examples

 
   Suppose that you want to create a new SPK file called 'new.spk' 
   that contains a single type 5 SPK segment and has room for at 
   least 5000 comment characters. The following code fragment should 
   take care of this for you, assuming that all of the variables 
   passed to the SPK type 5 segment writer have appropriate values 
   and no errors occur. 
 
      #include "SpiceUsr.h"
         .
         .
         . 
      name   = "new.spk";
      ifname = "test spk file";
 
      spkopn_c ( name, ifname, 5000,  &handle ); 
      spkw05_c ( handle, objid, cntrid, cframe, etbeg, 
                 etend, segmid, cntrgm, nstate, state, 
                 epoch                                 );
      spkcls_c ( handle );
 

Restrictions

 
   None. 
 

Literature_References

 
   None. 
 

Author_and_Institution

 
   F.S. Turner        (JPL)
 

Version

 
   -CSPICE Version 1.1.0, 20-APR-2005 (NJB)

       Bug fix:  address, rather than value, of `ncomch' is now 
       passed to spkopn_.

       Header comments indicating that `ncomch' is not used have
       been deleted.
       
   -CSPICE Version 1.0.0, 16-MAR-1999 (FST)

Index_Entries

 
   open a new spk file 
 
Wed Apr  5 17:54:43 2017