Procedure

   sigerr_c ( Signal Error Condition ) 

   void sigerr_c ( ConstSpiceChar * msg )

Abstract

   Inform the CSPICE error processing mechanism that an error has
   occurred, and specify the type of error.

Required_Reading

   ERROR

Keywords

   ERROR

Brief_I/O

   VARIABLE  I/O  DESCRIPTION
   --------  ---  --------------------------------------------------
   msg        I   A short error message.

Detailed_Input

   msg         A ``short'' error message.
               msg indicates the type of error that has occurred.

               Only the first 25 characters of msg will be stored;
               additional characters will be truncated.

               Generally, msg will be stored internally by the CSPICE
               error handling mechanism. The only exception
               is the case in which the user has commanded the error
               handling mechanism to ``ignore'' the error indicated by
               msg.

               As a default, msg will be output to the standard output.
               See the required reading file for a discussion of how
               to customize CSPICE error handling behavior, and
               in particular, the disposition of msg.

Detailed_Output

   None.

Parameters

   None.

Exceptions

   1)  This routine is part of the interface to the CSPICE error
       handling mechanism. For this reason, this routine does not
       participate in the trace scheme, even though it has external
       references, except in the following two cases.

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

   3)  If the `msg' input string has zero length, the error
       SPICE(EMPTYSTRING) is signaled.

Files

   None.

Particulars

   First of all, please read the ``required reading'' file.
   The information below will make a lot more sense if you do.

   This is the routine used by CSPICE to signal the detection
   of errors.

   Making a call to sigerr_c is the way to inform the error
   handling mechanism that an error has occurred.

   Specifically, the effects of this routine are:

   1. If responding to the error indicated by msg has
       not been disabled:

       a. msg will be stored internally. As a result,
          The CSPICE routine, getmsg, will be able to
          retrieve msg, until msg has been ``erased''
          by a call to reset_c, or overwritten by another
          call to sigerr_c.

       b. An indication of an ``error condition'' will
          be set internally. The CSPICE logical
          function, failed_c, will take the value, SPICETRUE,
          as a result, until the error condition is
          negated by a call to reset_c.

       c. All of the error messages that have been selected
          for automatic output via errprt_c will be output.
          The set of messages is some subset of { short message,
          long message, explanation of short message,
          traceback, and default message }.

       d. If the error response mode is not "RETURN",
          Setting of the long error message is enabled.
          You can't re-set the long error message, once
           it has been set, without first signaling an error.

       e. In "RETURN" mode, further signaling of error
          messages, and setting of the long message, are disabled.
          (These capabilities can be re-enabled by calling RESET).


   2. If the error handling mechanism has been commanded to
       ``ignore'' the error indicated by msg, the call to sigerr_c
       has no effect.

   If you wish to set the long error message, call
   setmsg_c BEFORE calling sigerr_c.

Examples

   The numerical results shown for these examples may differ across
   platforms. The results depend on the SPICE kernels used as
   input, the compiler and supporting libraries, and the machine
   specific arithmetic implementation.

   1) Create a user-defined error message, including both the
      short and long messages, providing the value of an integer
      and a double precision variables within the long message,
      and signal the error.


      Example code begins here.


      /.
         Program sigerr_ex1
      ./
      #include "SpiceUsr.h"

      int main()
      {

         /.
         Set long error message, with two different `marker'
         strings where the value of the variables will go.
         Our markers are "#" and "XX".
         ./
         setmsg_c ( "LONG MESSAGE.  Invalid operation value. "
                    "  The value was #.  Left endpoint "
                    "exceeded right endpoint.  The left "
                    "endpoint was:  XX."                      );

         /.
         Insert the integer number where the # is now.
         ./
         errint_c ( "#", 5 );

         /.
         Insert a double precision number where the XX is now.
         ./
         errdp_c ( "XX", 910.26111991 );

         /.
         Signal the error.
         ./
         sigerr_c ( "SPICE(USERDEFINED)" );

         return ( 0 );
      }


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


      =====================================================================

      Toolkit version: N0066

      SPICE(USERDEFINED) --

      LONG MESSAGE. Invalid operation value. The value was 5. Left endpoint
      exceeded right endpoint. The left endpoint was: 9.1026111991000E+02.

      Oh, by the way:  The SPICELIB error handling actions are USER-
      TAILORABLE.  You can choose whether the Toolkit aborts or continues
      when errors occur, which error messages to output, and where to send
      the output.  Please read the ERROR "Required Reading" file, or see
      the routines ERRACT, ERRDEV, and ERRPRT.

      =====================================================================


      Note that the execution of this program produces the error
      SPICE(USERDEFINED), which follows the NAIF standard as
      described in the ERROR required reading.


   2) Create a user-defined error message, including only the
      short messages, and signal the error.


      Example code begins here.


      /.
         Program sigerr_ex2
      ./
      #include "SpiceUsr.h"

      int main()
      {

         /.
         Signal the error; the short message is given by
         sigerr_c input argument.
         ./
         sigerr_c ( "SPICE(USERDEFINED)" );

         return ( 0 );
      }


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


      =====================================================================

      Toolkit version: N0066

      SPICE(USERDEFINED) --

        Oh, by the way:  The SPICELIB error handling actions are USER-
      TAILORABLE.  You can choose whether the Toolkit aborts or continues
      when errors occur, which error messages to output, and where to send
      the output.  Please read the ERROR "Required Reading" file, or see
      the routines ERRACT, ERRDEV, and ERRPRT.

      =====================================================================


      Note that the execution of this program produces the same
      SPICE(USERDEFINED) error as in Example #1, but in this case,
      only the short message is presented.

Restrictions

   None.

Literature_References

   None.

Author_and_Institution

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

Version

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

       Changed input argument "message" to "msg" for consistency with
       other routines.

       Edited the header to comply with NAIF standard. Added
       complete code example.

       Improved entry #1 and added entries #2 and #3 in -Exceptions
       section.

   -CSPICE Version 1.1.2, 23-JUL-2001 (NJB)

       Removed tab characters from source file.

   -CSPICE Version 1.1.1, 25-MAR-1998 (EDW)

       Minor corrections to header.

   -CSPICE Version 1.1.0, 08-FEB-1998 (NJB)

       Re-implemented routine without dynamically allocated, temporary
       strings. Made various header fixes.

   -CSPICE Version 1.0.0, 25-OCT-1997 (EDW) (KRG)

Index_Entries

   signal error condition