Abstract

   CSPICE_LCASE converts the characters in an input string
   to lower case.

I/O

   Given:

      in       the input string.

               help, in
                  STRING = Scalar

   the call:

      cspice_lcase, in, out

   returns:

      out      the output string.

               help, out
                  STRING = Scalar

               This is the input string with all uppercase letters converted
               to lowercase. Non-letters are not affected.

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) Convert an input string to lower case.

      Example code begins here.


      PRO lcase_ex1

         ;;
         ;; A string of upper case characters.
         ;;
         up_string = 'CARTHAGO DESTRUCTUS EST'

         ;;
         ;; Convert up_string to lowercase.
         ;;
         cspice_lcase, up_string, lower
         print, lower

      END


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


      carthago destructus est

Particulars

   Convert each uppercase character in `in' to lowercase.

   The routine allocates memory for the `out' string based on the length of
   the `in' string. An `in' string with length zero is an no-op.

   IDL native code to perform the same operation:

      out = strlowcase (in)

Exceptions

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

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

   3)  If the output argument `out' is not a named variable, 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, 17-JUN-2021 (JDR)

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

       Added -Particulars section, extending its contents with the
       details provided in the former -I/O section descriptions for "in"
       and "out" arguments.

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

       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

   convert to lowercase