Index of Functions: A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 
Index Page
cspice_tkvrsn

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries


Abstract


   CSPICE_TKVRSN returns the latest version string of a given item such as
   the Toolkit or a routine name.

I/O


   Given:

      item     the item for which a version string is to be returned.

               help, item
                  STRING = Scalar

               `item' may be 'TOOLKIT', routine names, or program names.
               `item' is case insensitive.

               Currently, the only `item' supported is 'TOOLKIT'
               and it will return the toolkit version number.

               Any other `item' will return 'No version found.'

   the call:

      tkvrsn = cspice_tkvrsn( item )

   returns:

      tkvrsn   the latest version string for the specified `item'.

               help, tkvrsn
                  STRING = Scalar

               If `item' is not one of the items having a version,
               the value 'No version found.' will be returned.

Parameters


   None.

Examples


   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

   1) Print the execution date and the current toolkit version.

      Example code begins here.


      PRO tkvrsn_ex1

         ;;
         ;; Execution date and toolkit version.
         ;;
         print, 'On ' + SYSTIME() + ' the latest toolkit version was:'
         print, '   ', cspice_tkvrsn( 'toolkit' )

      END


      When this program was executed on a Mac/Intel/IDL8.x/64-bit
      platform, the output was:


      On Tue Jun  5 12:48:46 2018 the latest toolkit version was:
         CSPICE_N0066


Particulars


   None.

Exceptions


   1)  If the `item' whose version string is requested is not
       recognized, the string 'No version found.' is returned.

   2)  If the input argument `item' is undefined, an error is
       signaled by the IDL error handling system.

   3)  If the input argument `item' is not of the expected type, or
       it does not have the expected dimensions and size, an error is
       signaled by the Icy interface.

Files


   None.

Restrictions


   None.

Required_Reading


   ICY.REQ

Literature_References


   None.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version


   -Icy Version 1.0.1, 10-AUG-2021 (JDR)

       Edited the header to comply with NAIF standard. Added example's
       problem statement and reformatted example's output.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections.

       Minor edits to the -I/O section to comply with NAIF standard.

       Removed reference to the routine's corresponding CSPICE header from
       -Abstract section.

       Added arguments' type and size information in the -I/O section.

   -Icy Version 1.0.0, 16-JUN-2003 (EDW)

Index_Entries


   None.



Fri Dec 31 18:43:08 2021