Esa_Interface_Value_Get()
Abstract
Gets the value of an interface.
Syntax
Esa_Interface_Value_Get (esa_state_ptr, status_ptr, interface, data_ptr)
| Argument | Type | Description |
|---|---|---|
esa_state_ptr |
EsaT_State_Handle |
ESA state information generated by Esa_Init() |
status_ptr |
int * |
if the return value is EsaC_Comp_Failure, a status value indicating the source of the failure. |
interface |
EsaT_Interface |
identifier of the interface of interest |
data_ptr |
void * |
Buffer to hold the interface value |
Return Type
EsaT_Compcode
EsaC_Comp_Success if the value is obtained; EsaC_Comp_Failure otherwise (in which case *status_ptr contains a value indicating the source of the failure).
Header
esa.h
Details
This function retrieves the value of an interface asynchronously (as opposed to a registered callback).
data_ptr should be the address of a defined variable of the appropriate type (based on the interface type):
Table 1: ESA Interface Type Constants
| Interface Type | Variable Type for data_ptr |
|---|---|
EsaC_Value_Type_Integer |
int |
EsaC_Value_Type_Double |
double |
EsaC_Value_Type_String |
char [<dimension large enough to store value>] |
EsaC_Value_Type_Boolean |
char |
EsaC_Value_Type_Ieee_Stdlogic |
char |
EsaC_Value_Type_Bit |
char |
EsaC_Value_Type_Character |
char |
EsaC_Value_Type_Pointer |
void * |