tkvrsn_c |
Table of contents
Proceduretkvrsn_c ( Toolkit version strings ) ConstSpiceChar * tkvrsn_c ( ConstSpiceChar * item ) AbstractReturn the latest version string of a given item such as the Toolkit or a routine name. Required_ReadingNone. KeywordsUTILITY Brief_I/OVARIABLE I/O DESCRIPTION -------- --- -------------------------------------------------- item I Item for which a version string is desired. The function returns a pointer to a version string. Detailed_Inputitem is the item for which a version string is to be returned. item may be "TOOLKIT", entry point 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." Detailed_OutputThe function returns a pointer to the latest version string for the specified item. If item is not one of the items having a version, a pointer to the string "No version found." will return. ParametersNone. Exceptions1) If the `item' whose version string is requested is not recognized, the string "No version found." is returned. 2) If the `item' input string pointer is null, the error SPICE(NULLPOINTER) is signaled. The function returns an empty string. 3) If the `item' input string has zero length, the error SPICE(EMPTYSTRING) is signaled. The function returns an empty string. FilesNone. ParticularsNone. ExamplesSuppose you want to find out the recent Toolkit configuration version number. Using the code fragment below: ConstSpiceChar * versn; versn = tkvrsn_c ( "TOOLKIT" ); The pointer versn would refer to a string similar to the one shown below (except that the version will be current): "CSPICE_N0035" RestrictionsNone. Literature_ReferencesNone. Author_and_InstitutionN.J. Bachman (JPL) J. Diaz del Rio (ODC Space) H.A. Neilan (JPL) W.L. Taber (JPL) E.D. Wright (JPL) Version-CSPICE Version 2.3.1, 13-AUG-2021 (JDR) Edited the header to comply with NAIF standard. Updated -Exceptions section: routine is not Error free; added entries #2 and #3. -CSPICE Version 2.3.0, 06-FEB-2002 (EDW) (NJB) Changed the return type from (SpiceChar *) to (ConstSpiceChar *). Corrected example code to show use of (ConstSpiceChar *) return type. Edited the header. -CSPICE Version 2.2.0, 03-SEP-1999 (NJB) Return type changed to (SpiceChar *). Function now cleans out version string before writing to it. -CSPICE Version 2.1.0, 08-FEB-1998 (NJB) References to C2F_CreateStr_Sig were removed; code was cleaned up accordingly. String checks are now done using the macro CHKFSTR_VAL. -CSPICE Version 2.0.0, 11-NOV-1997 (NJB) Updated to use the SPICELIB routine TKVRSN to obtain the version string for SPICELIB. Updated header to remove outdated restrictions. Changed example to reflect CSPICE version string. -CSPICE Version 1.0.0, 25-OCT-1997 (NJB) (HAN) (WLT) Based on SPICELIB Version 2.4.0, 31-JUL-1997 (WLT) Index_EntriesReturn version strings |
Fri Dec 31 18:41:14 2021