ekopn_c

Index Page ekopn_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 ekopn_c ( ConstSpiceChar    * fname,
                      ConstSpiceChar    * ifname,
                      SpiceInt            ncomch,
                      SpiceInt          * handle )
#### Abstract
       Open a new E-kernel file and prepare the file for writing.
#### Required_Reading
       EK
       NAIF_IDS
       TIME
#### Keywords
       EK
       FILES
       UTILITY
#### Brief_I/O
       Variable  I/O  Description
       --------  ---  --------------------------------------------------
       fname      I   Name of EK file.
       ifname     I   Internal file name.
       ncomch     I   The number of characters to reserve for comments.
       handle     O   Handle attached to new EK file.
#### Detailed_Input
       fname          is the name of a new E-kernel file to be created.

       ifname         is the internal file name of a new E-kernel.  The
                      internal file name may be up to 60 characters in
                      length, not including the null terminator.

       ncomch         is the amount of space, measured in characters, to
                      be allocated in the comment area when the new EK
                      file is created.  It is not necessary to allocate
                      space in advance in order to add comments, but
                      doing so may greatly increase the efficiency with
                      which comments may be added.  Making room for
                      comments after data has already been added to the
                      file involves moving the data, and thus is slower.

                      ncomch must be greater than or equal to zero.
#### Detailed_Output
       handle         is the EK handle of the file designated by fname.
                      This handle is used to identify the file to other
                      EK routines.
#### Parameters
       None.
#### Exceptions
       1)  If NCOMCH is less than zero, the error SPICE(INVALIDCOUNT)
           will be signalled.  No file will be created.

       2)  If IFNAME is invalid, the error will be diagnosed by routines
           called by this routine.

       3)  If the indicated file cannot be opened, the error will be
           diagnosed by routines called by this routine.  The new file
           will be deleted.

       4)  If an I/O error occurs while reading or writing the indicated
           file, the error will be diagnosed by routines called by this
           routine.
#### Files
       See the EK Required Reading for a discussion of the EK file
       format.
#### Particulars
       This routine operates by side effects:  it opens and prepares
       an EK for addition of data.
#### Examples
       1)  Open a new EK file with name "my.ek" and internal file
           name "test ek/1995-JUL-17":

           ekopn_c ( "my.ek",  "test ek/1995-JUL-17",  &handle  );
#### Restrictions
       None.
#### Literature_References
       None.
#### Author_and_Institution
       N.J. Bachman   (JPL)
#### Version
       -CSPICE Version 1.0.0, 31-MAR-1998 (NJB)

          Based on SPICELIB Version 1.0.0, 26-SEP-1995 (NJB)
#### Index_Entries
       open new E-kernel
       open new EK
#### Link to routine ekopn_c source file ekopn_c.c

    Thu Apr 16 08:57:57 2009