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

Abstract
I/O
Examples
Particulars
Required Reading
Version
Index_Entries

Abstract


   CSPICE_STPOOL retrieve the nth string from a kernel pool
   variable, where the string may be continued across several
   components of the kernel pool variable.

   For important details concerning this module's function, please refer to
   the CSPICE routine stpool_c.

I/O

   
   Given:
   
      item     the scalar string name of the kernel pool variable
   
      nth      the integer index of the 'item' component to retrieve
   
      contin   the character sequence used to indicate continuation
   
   the call:
   
      cspice_stpool, item, nth, contin, string, size, found
   
   returns:
   
      string   the nth full string corresponding to pool variable 
               'item' concatenated across continuations
   
      size     the integer number of characters in 'string'
   
      found    a boolean flag indicating success (TRUE) or failure
               (FALSE) of the call
   

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.

      
      ;;
      ;; Load the example kernel (stpool_t.ker) containing the kernel 
      ;; variable:
      ;;
      ;;  SPK_FILES = ( 'this_is_the_full_path_specification_*', 
      ;;              'of_a_file_with_a_long_name', 
      ;;              'this_is_the_full_path_specification_*', 
      ;;              'of_a_second_file_name' )
      ;;
      cspice_furnsh, 'stpool_t.ker'
    
      ;;
      ;; Retrieve the first string from 'item'. Set
      ;; '*' as the continuation marker
      ;;
      item   = "SPK_FILES"
      nth    = 0
      contin = '*'
      
      ;;
      ;; Call the function.
      ;;
      cspice_stpool, item, nth, contin, string, size, found
    
      ;;
      ;; Output the value and size if 'nth' element of 'item'
      ;; was found.
      ;;
      if ( found ) then begin
         print, "String index: ", nth
         print, "Found string: ", string
         print, "String size : ", size
      endif
   
      print
   
      ;;
      ;; Retrieve the second string from 'item'.
      ;;
      nth = 1
   
      ;;
      ;; Call the function.
      ;;
      cspice_stpool, item, nth, contin, string, size, found
    
      ;;
      ;; Output the string value and size if 'nth' element of 'item'
      ;; was found.
      ;;
      if ( found ) then begin
         print, "String index: ", nth
         print, "String size : ", size
         print, "Found string: "
         print,  string
      endif
   
      ;;
      ;; End of procedure, unload the kernel.
      ;;
      cspice_unload, 'stpool_t.ker'
   
   IDL outputs:
   
      String index:  0
      String size : 62
      Found string:
      this_is_the_full_path_specification_of_a_file_with_a_long_name
   
      String index:  1
      String size : 57
      Found string: 
      this_is_the_full_path_specification_of_a_second_file_name

Particulars


   None.

Required Reading


   ICY.REQ
   KERNEL.REQ

Version


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

Index_Entries

 
   Retrieve a continued string value from the kernel pool 
 



Wed Apr  5 17:58:04 2017