EDCS Binding to C

6  Function definitions

EDCS bar

6.1  Introduction

6.1.1  Table of contents

Table 6.1 — Table of contents

6  Function definitions

6.1  Introduction

6.1.1  Table of contents<

6.1.2  Notational

6.2  Conversion API functions

EDCS_ConvertQuantityValue

EDCS_GetHighestCodesUsed

6.1.2  Notational conventions

The binding of each EDCS function utilizes the following template:

EDCS C Binding Function Name

Abstract Function:  EDCS Abstract Function Name

ReturnValueDataType EDCS_FunctionName (

[const]

Parameter0DataType

parameter_0_name,

/* parameter 0 comment */

[const]

Parameter1DataType

parameter_1_name,

/* parameter 1 comment */

. . .

 [const]

ParameterNDataType

parameter_N_name,

/* parameter N comment */

);

The EDCS C binding function name is formed by a sentinal “EDCS_” followed by the name without spaces and with words capitalized. The EDCS abstract function name is the name used in ISO/IEC 18025.

The return value data type and parameter data types may be found in clause 5 of this standard or may be a standard C data type (e.g., void). If the parameter data type is preceded by the word “const”, the input parameter is a pointer to a structured representation type.

The parameter names are formed by using lower case words separated by underscores.

To the right of each parameter declaration is a C comment field which provides a brief description of the parameter. If the comment begins with “OUT”, it means the argument is used as an output parameter; the implementation returns data to the application through this argument. If the comment begins with “I/O”, it means the argument both provides data necessary for the correction operation of the function as well as returning results from a function. Arguments without “OUT” are input-only parameters.

EDCS bar

6.2  Conversion API functions

EDCS_ConvertQuantityValue 

Abstract Function:  ConvertQuantityValue

EDCS_Status_Code EDCS_ConvertQuantityValue (

const

EDCS_Real_Value

*from_value,

/* value to convert */

 

EDCS_Real_Value

*to_value

/* OUT converted value */

);

EDCS_GetHighestCodesUsed

Abstract Function:  Get_Highest_Codes_Used

EDCS_Status_Code EDCS_GetHighestCodesUsed (

 

EDCS_Dictionary_Type

*input_value,

/* dictionary */

 

EDCS_Integer

*standard_code,

/* OUT highest std code */

 

EDCS_Integer

*registered_code

/* OUT highest reg code */

);

EDCS bar