code (ULONG) - input

A nonzero return value returned by a control-program function.

A nonzero return value indicates that an error has occurred.

pClass (PULONG) - output

A pointer to the ULONG in which the classification for the error is returned.

The following values are possible:

• ERRCLASS_OUTRES Out of resources

• ERRCLASS_TEMPSIT
  Temporary situation

• ERRCLASS_AUTH
  Authorization failed

• ERRCLASS_INTRN
  Internal error

• ERRCLASS_HRDFAIL
  Device hardware failure

• ERRCLASS_SYSFAIL
  System failure

• ERRCLASS_APPERR
  Probable application error

• ERRCLASS_NOTFND
  Item not located

• ERRCLASS_BADFMT
  Bad format for function or data

  10

  ERRCLASS_LOCKED
  Resource or data locked
  11
  ERRCLASS_MEDIA
  Incorrect media, cyclic redundancy check (CRC) error
  12
  ERRCLASS_ALREADY
  Action already taken or done, or resource already exists
  13
  ERRCLASS_UNK
  Unclassified
  14
  ERRCLASS_CANT
  Cannot perform requested action
  15
  ERRCLASS_TIME
  Timeout

  pAction (PULONG) - output

  A pointer to the ULONG in which the recommended corrective action for the error is returned.

  The following values are possible:

  • ERRACT_RETRY Retry immediately

  • ERRACT_DLYRET
    Delay and retry

  • ERRACT_USER
    Bad user input - get new values

  • ERRACT_ABORT
    Terminate in an orderly manner

  • ERRACT_PANIC
    Terminate immediately

  • ERRACT_IGNORE
    Ignore error

  • ERRACT_INTRET
    Retry after user intervention

  pLocus (PULONG) - output

  A pointer to the ULONG in which the error origination is returned.

  The following values are possible:

  • ERRLOC_UNK Unknown

  • ERRLOC_DISK
    Random-access device such as a disk

  • ERRLOC_NET
    Network

  • ERRLOC_SERDEV
    Serial device

  • ERRLOC_MEM
    Memory

  ulrc (APIRET) - returns

  Return Code.

  DosErrClass returns one of the following value:

  • NO_ERROR

    For a full list of error codes, see Errors.

  ---

  [Back] [Next]