ordercode (ULONG) - input

DosExitList action and invocation order.

ordercode contains two one-byte fields in the low-order word. The high-order word is zero.

The low-order byte of the low-order word indicates which action DosExitList performs. This function can update the list of routines or transfer to the next address on the termination list at the completion of a routine. The values of the byte and their meanings are as follows:

• EXLST_ADD
  Add an address to the termination list.

• EXLST_REMOVE
  Remove an address from the termination list.

• EXLST_EXIT
  When termination processing completes, transfer to the next address on the termination list.

  The high-order byte of the low-order word indicates the invocation order. This value is valid only when the low-order byte is 1 (add an address). For the other low-order byte values, the high-order byte of the low-order word must be set to zero.

  The invocation order indicates where the routine address is to be placed in an ordered list. This list determines the order in which the exit list routines are invoked. Routines with a value of 0 are invoked first, and routines with a value of 255 are invoked last. If more than one routine is added with the same invocation order value, the last routine to be added is invoked first. The following values are used by OS/2 components:

  0x80 - 0x88

  OS/2 Extended Edition Database Manager
  0x90 - 0x98
  OS/2 Extended Edition Communications Manager
  0xA0 - 0xA8
  OS/2 Presentation Manager
  0xB0
  OS/2 Keyboard (KBD) component
  0xC0
  OS/2 Video (VIO) component
  0xD0
  OS/2 Interprocess Communication (IPC) Queues component

  pfn (PFNEXITLIST) - input

  The address of a routine to be run.

  ulrc (APIRET) - returns

  Return Code.

  DosExitList returns one of the following values:

  • NO_ERROR 1
    ERROR_INVALID_FUNCTION
    8
    ERROR_NOT_ENOUGH_MEMORY
    13
    ERROR_INVALID_DATA
    For a full list of error codes, see Errors.

  ---

  [Back] [Next]