DosRaiseException

From EDM2
Jump to: navigation, search

Raises an exception for the current thread.

Syntax

#define INCL_DOSEXCEPTIONS
#include <os2.h>

PEXCEPTIONREPORTRECORD pexcept; /* A pointer to an exception report record that contains
                                   exception-specific information needed for the exception
                                   to be raised. */
APIRET                 ulrc;    /* Return Code. */

ulrc = DosRaiseException(pexcept);

Parameters

pexcept (PEXCEPTIONREPORTRECORD) - input 
A pointer to an exception report record that contains exception-specific information needed for the exception to be raised.

The pointer to the exception report record, as well as certain handler flags in the structure, are supplied by the system.

Return Code

ulrc (APIRET) - returns

DosRaiseException returns the following value:

  • 0 NO_ERROR

Remarks

Note: Do not make Presentation Manager calls from exception handlers.

DosRaiseException enables a thread to raise a synchronous exception that has been deferred from a must-complete section.

DosRaiseException can also be used to simulate an asynchronous or synchronous exception.

Example Code

This example shows how to raise an exception for the current thread.

#define INCL_DOSPROCESS       /* DOS process values (for DosSleep) */
#define INCL_DOSEXCEPTIONS    /* DOS exception values */
#define INCL_ERRORS           /* DOS error values     */
#include <os2.h>
#include <stdio.h>

ULONG _System MyTermHandler( PEXCEPTIONREPORTRECORD       p1,
                             PEXCEPTIONREGISTRATIONRECORD p2,
                             PCONTEXTRECORD               p3,
                             PVOID                        pv );
int main (VOID)
{
  EXCEPTIONREGISTRATIONRECORD RegRec  = {0};     /* Exception Registration Record */
  APIRET      rc      = NO_ERROR;   /* Return code                   */

  /* Add MyTermHandler to this thread's chain of exception handlers */

  RegRec.ExceptionHandler = (ERR)MyTermHandler;
  rc = DosSetExceptionHandler( &RegRec );
  if (rc != NO_ERROR) {
     printf("DosSetExceptionHandler error: return code = %u\n",rc);
     return 1;
  }

  printf("Terminate this program using Ctrl-C or Ctrl-Break.\n");

  rc = DosSleep(60000L);   /* Give user plenty of time to comply... */

  rc = DosUnsetExceptionHandler( &RegRec );
  if (rc != NO_ERROR) {
     printf("DosUnsetExceptionHandler error: return code = %u\n",rc);
     return 1;
  }
  return NO_ERROR;
}
/***********************************************************************/
ULONG _System MyTermHandler( PEXCEPTIONREPORTRECORD       p1,
                             PEXCEPTIONREGISTRATIONRECORD p2,
                             PCONTEXTRECORD               p3,
                             PVOID                        pv )
{
  APIRET  rc = NO_ERROR;

  printf("*** MyTermHandler entered: ExceptionNum = %x\n",p1->ExceptionNum);

  rc = DosUnsetExceptionHandler( p2 );  /* Stop recursive entry to handler */
  rc = DosRaiseException( p1 );         /* Exception Report Record */
  if (rc != NO_ERROR) {
     printf("DosRaiseException error:  return code = %u\n", rc);
  }

  return XCPT_CONTINUE_SEARCH;
}

Related Functions