AioGetAiStopLevelEx


Function

Retrieves the level when the level comparison is stopped. Level settings are stored in Voltage or Current.

Format

Ret = AioGetAiStopLevelEx ( Id , AiChannel , AiStopLevel , AiDirection )

Parameters

Id [ C, C++ : short ] [ Python : ctypes.c_short ]
Specifies the Device ID retrieved from AioInit function.

AiChannel [ C, C++ : short ] [ Python : ctypes.c_short ]
Reserved. it should set 0(Zero).

AiStopLevel [ C, C++ : float * ] [ Python : ctypes.POINTER(ctypes.c_float) ]
Specifies the address of the variable that stores the level comparison data. The data are stored in Voltage or Current.

AiDirection [ C, C++ : short * ] [ Python : ctypes.POINTER(ctypes.c_short) ]
Specifies the address of the variable that stores the direction of the level comparison.

0

Both edges

1

Rising edge

2

Falling edge

Return value

Ret [ C, C++ : long ] [ Python : ctypes.c_long ]

Return values

Content

0

Normality completion

7

Execute AioResetDevice function because the device has recovered from standby mode

10001

Invalid Id was specified
Use the Id retrieved from AioInit to specify the Id in this function.

10002

AIO driver can't be called
At first, perform AioInit function.

11950

The value of AiChannel is outside the designated range of the function

11951

Pointer to AiStopLevel is NULL
Specify the address of variable to parameter.

11952

Pointer to AiDirection is NULL
Specify the address of variable to parameter.

20001

This function can't be used by this device

20002

Can not use while by another device works
To use this function, analog input operation must be stopped.

20003

Can not use because another process is using the device
When another process is using the device, all functions except for those that support multi-process can not be performed.

21950

The value of AiChannel is outside the designated range of the device being used

Initial value

In all devices, AiChannel = 0, AiDirection = 0

Resolution of device is 12 bit

AiStartLevel = Voltage or Current value equals to 800H in binary value

Resolution of device is 16 bit

AiStartLevel = Voltage or Current value equals to 8000H in binary value

Remarks

This function cannot be used on devices without the analog input function.
If the device is in operation, the function cannot be performed.

Example

Retrieves the level and the direction of the comparison stop in channel 0.

C, C++

long Ret;
float AiStopLevel;
short AiDirection;
Ret = AioGetAiStopLevelEx ( Id , 0 , &AiStopLevel , &AiDirection );
 

Python

Ret = ctypes.c_long()
AiStopLevel = ctypes.c_float()
AiDirection = ctypes.c_short()
Ret.value = caio.AioGetAiStopLevelEx ( Id , 0 , ctypes.byref(AiStopLevel) , ctypes.byref(AiDirection) )
 

See also

AioSetAiStopLevelEx