Procedure

   ucase_c ( Convert to uppercase ) 

   void ucase_c ( SpiceChar   * in,
                  SpiceInt      outlen,
                  SpiceChar   * out    )

Abstract

   Convert the characters in a string to uppercase.

Required_Reading

   None.

Keywords

   ASCII
   CHARACTER

Brief_I/O

   VARIABLE  I/O  DESCRIPTION
   --------  ---  --------------------------------------------------
   in         I   Input string.
   outlen     I   Maximum length of output string.
   out        O   Output string, all uppercase.

Detailed_Input

   in          is the input string.

   outlen      is the maximum allowed length of the output string,
               including the terminating null.

Detailed_Output

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

               If

                  outlen < strlen(in)+1

               the output string will be truncated on the right.

               A terminating null will be placed in out at position

                  min ( strlen(in),  outlen-1 )

               unless `outlen' is less than or equal to zero.

               `out' may overwrite `in'.

Parameters

   None.

Exceptions

   1)  If the output string length is less than the input string
       length, the result will be truncated on the right.

   2)  If the `in' input string pointer is null, the error
       SPICE(NULLPOINTER) is signaled.

   3)  If the `out' output string pointer is null, the error
       SPICE(NULLPOINTER) is signaled.

   4)  If the `out' output string has length less than two
       characters, the error SPICE(STRINGTOOSHORT) is signaled, since
       the output string is too short to contain one character of
       output data plus a null terminator.

Files

   None.

Particulars

   Convert each lowercase character in `in' to uppercase.

Examples

   "This is an example"   becomes   "THIS IS AN EXAMPLE"
   "12345 +-=? > * $ &"             "12345 +-=? > * $ &"

Restrictions

   None.

Literature_References

   None.

Author_and_Institution

   N.J. Bachman        (JPL)
   J. Diaz del Rio     (ODC Space)
   K.R. Gehringer      (JPL)

Version

   -CSPICE Version 1.2.0, 05-AUG-2021 (JDR)

       Changed the input argument "lenout" to "outlen" for consistency with
       other routines.

       Edited the header to comply with NAIF standard.

   -CSPICE Version 1.1.0, 26-JAN-2005 (NJB)

       Cast to SpiceInt was applied to strlen output to suppress
       compiler warnings about comparison of signed and unsigned types.

   -CSPICE Version 2.0.0, 26-AUG-1999 (NJB)

      Added string error checks.

   -CSPICE Version 1.0.0, 08-FEB-1998 (NJB) (KRG)

      Based on SPICELIB Version 1.1.0, 13-MAR-1996 (KRG)

Index_Entries

   convert to uppercase