EDCS Reference Manual
Types
EDCS_Status_Code
/*
 * ENUM: EDCS_Status_Code
 *
 *   This data type is used to specify error conditions for all EDCS
 *   functions that can fail and that retrieve dictionary information
 *   from various EDCS dictionaries.
 */
typedef enum
{
EDCS_STAT_CODE_SUCCESS, (notes)
EDCS_STAT_CODE_INVALID_SOURCE_UNIT, (notes)
EDCS_STAT_CODE_INVALID_DEST_UNIT, (notes)
EDCS_STAT_CODE_INVALID_SOURCE_SCALE, (notes)
EDCS_STAT_CODE_INVALID_DEST_SCALE, (notes)
EDCS_STAT_CODE_UNITS_NOT_EQUIVALENT, (notes)
EDCS_STAT_CODE_FAILURE, (notes)
EDCS_STAT_CODE_NULL_REQUIRED_PARAMETER, (notes)
EDCS_STAT_CODE_INVALID_CODE, (notes)
EDCS_STAT_CODE_INVALID_LABEL, (notes)
EDCS_STAT_CODE_INVALID_SYMBOLIC_CONSTANT (notes)
} EDCS_Status_Code;


Enumerant Notes


EDCS_STAT_CODE_SUCCESS

 Operation succeeded.

EDCS_STAT_CODE_INVALID_SOURCE_UNIT

 An invalid unit was passed in for a required input parameter,
 the source unit in which a given quantity is defined.

EDCS_STAT_CODE_INVALID_DEST_UNIT

 An invalid unit was passed in for a required input parameter,
 the destination unit in which a given quantity is to be
 expressed.

EDCS_STAT_CODE_INVALID_SOURCE_SCALE

 An invalid scale was passed in for a required input parameter,
 the source scale in which a given quantity is defined.

EDCS_STAT_CODE_INVALID_DEST_SCALE

 An invalid scale was passed in for a required input parameter,
 the destination scale in which a given quantity is to be
 expressed.

EDCS_STAT_CODE_UNITS_NOT_EQUIVALENT

 An attempted conversion of a quantity from one unit and scale
 to a different unit and scale failed because the units did
 not belong to the same equivalence class (EQ).

EDCS_STAT_CODE_FAILURE

 An error condition occurred that is not covered by
 a more specific status code.

EDCS_STAT_CODE_NULL_REQUIRED_PARAMETER

 A NULL value was passed in for a required parameter.

EDCS_STAT_CODE_INVALID_CODE

 An invalid code was encountered for the given dictionary.

EDCS_STAT_CODE_INVALID_LABEL

 An invalid label was encountered for the given dictionary.

EDCS_STAT_CODE_INVALID_SYMBOLIC_CONSTANT

 An invalid 'symbolic constant' was encountered for the
 given dictionary.



Prev: EDCS_Short_Integer_Unsigned. Next: EDCS_String.


Return to: Top of this Page, Type Index

Last updated: May 15, 2003 Copyright © 2003 SEDRIS™