Procedure

   esrchc_c ( Equivalence search, character ) 

   SpiceInt esrchc_c ( ConstSpiceChar  * value,
                       SpiceInt          ndim,
                       SpiceInt          arrlen,
                       const void      * array    )

Abstract

   Search for a given value within a character string array.
   Return the index of the first equivalent array entry, or -1
   if no equivalent element is found.

Required_Reading

   None.

Keywords

   ARRAY
   SEARCH

Brief_I/O

   VARIABLE  I/O  DESCRIPTION
   --------  ---  --------------------------------------------------
   value      I   Key value to be found in array.
   ndim       I   Dimension of array.
   arrlen     I   String length.
   array      I   Character string array to search.

   The function returns the index of the first array entry
   equivalent to value, or -1 if none is found.

Detailed_Input

   value       is the key value to be found in the array. Trailing
               blanks in this key are not significant: string matches
               found by this routine do not require trailing blanks in
               value to match those in the corresponding element of
               `array'.

               `value' may be an empty string.

   ndim        is the dimension of the array.

   arrlen      is the declared length of the strings in the input
               string `array', including null terminators. The input
               array should be declared with dimension

                  [ndim][arrlen]

   array       is the array of character strings to be searched. Trailing
               blanks in the strings in this array are not significant.

Detailed_Output

   The function returns the index of the first element of the
   input array equivalent to the input value, or -1 if the
   array contains no such elements.

   Two strings are equivalent if they contain the same characters
   in the same order, when blanks are ignored and uppercase and
   lowercase characters are considered equal.

Parameters

   None.

Exceptions

   1)  If ndim < 1 the function value is -1. This is not considered
       an error.

   2)  If the `value' input string pointer is null, the error
       SPICE(NULLPOINTER) is signaled. The function returns the value
       -1.

   3)  If the `array' input array pointer is null, the error
       SPICE(NULLPOINTER) is signaled. The function returns the value
       -1.

   4)  If the `array' input array strings have length less than two
       characters, the error SPICE(STRINGTOOSHORT) is signaled. The
       function returns the value -1.

Files

   None.

Particulars

   esrchc_c is identical to isrchc_c, except that it looks for
   the first equivalent string (as defined by eqstr_c) instead
   of the first identical one.

Examples

   Let array be declared with dimension

      [NDIM][STRLEN]

   and contain the following elements:

      array[0] == "This"
      array[1] == "little"
      array[2] == "piggy"
      array[3] == "went"
      array[4] == "to"
      array[5] == "market"

   Then

      esrchc_c ( "PIGGY",      NDIM,  STRLEN,  array )  ==  2
      esrchc_c ( " LiTtLe  ",  NDIM,  STRLEN,  array )  ==  1
      esrchc_c ( "W e n t",    NDIM,  STRLEN,  array )  ==  3
      esrchc_c ( "mall",       NDIM,  STRLEN,  array )  == -1

Restrictions

   None.

Literature_References

   None.

Author_and_Institution

   N.J. Bachman        (JPL)
   J. Diaz del Rio     (ODC Space)
   I.M. Underwood      (JPL)

Version

   -CSPICE Version 1.1.0, 24-AUG-2021 (JDR)

       Changed the input argument name "lenvals" to "arrlen" for consistency
       with other routines.

       Edited the header to comply with NAIF standard.

       Removed entry #3 from -Exceptions section and updated the argument
       "value" description to indicate that empty strings are allowed.

   -CSPICE Version 1.0.0, 22-JUL-2002 (NJB) (IMU)

Index_Entries

   search array for equivalent character_string

Link to routine esrchc_c source file esrchc_c.c