Cascade Driver for Hilscher Fieldbus CIF Cards: Version 4.1
Prev |  | Next

# errorDescription

errorDescription -- provides the text associated with an error code.

## Synopsis

    (errorDescription error_code [protocol])

## Parameters

`error_code`

  The integer value returned by certain error messages.

`protocol`

  The communications protocol of the card (if applicable), used to differentiate between protocol-specific message errors (see Description below).

## Returns

If the `error_code` is valid:

        (errorDescription error_code error_string)

If the `error_code` is unknown:

        (errorDescription error_code)

## Description

Some of the error responses to commands contain error codes returned by the 'device-level' of the driver, or from the card itself--most notably the errors returned by the CIF message ('telegram') mechanism. This command gives you a descriptive string for these error codes.

Since there is some overlap between the telegram errors for different communications protocols, an optional `protocol` parameter is used to provide the appropriate mapping. The `protocol` name can be obtained from the cardProfile command, or is a `*` if the message error is not protocol-specific.

| The `protocol` feature is only necessary when querying with raw telegram errors (`0`-`255`). Any message errors returned by Cascade Driver commands (eg, see cifTelegram) are automatically mapped with the appropriate protocol to provide unique error codes, so that the `protocol` parmameter need not be specified.

Prev | Home | Next
enable | Up | exit

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.