AioGetAiStopOutRange


Function

Retrieves the settings of Out Range comparison stop condition.

Format

Ret = AioGetAiStopOutRange ( Id , AiChannel , Level1 , Level2 , StateTimes )

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).

Level1 [ C, C++ : long * ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the variable that stores the upper limit data of Out Range comparison. The data are stored in binary value.

Resolution of device is 12 bit

0 to 4095

Resolution of device is 16 bit

0 to 65535

Level2 [ C, C++ : long * ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the variable that stores the lower limit data of Out Range comparison. The data are stored in binary value.

Resolution of device is 12 bit

0 to 4095

Resolution of device is 16 bit

0 to 65535

StateTimes [ C, C++ : long * ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the variable that stores the state-held sampling times.

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.

12110

The value of AiChannel is outside the designated range of the function
Specify the channel setting in range: 0 <= AiChannel <= Max channel.

12111

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

12112

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

12113

Pointer to StateTimes 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.

22110

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

Initial value

In all devices, AiChannel = 0, StateTimes = 1, Level1 = 0, Level2 = 0

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 Out Range comparison level and state times of channel 0.

C, C++

long Ret;
long Level1;
long Level2;
long StateTimes;
Ret = AioGetAiStopOutRange ( Id , 0 , &Level1 , &Level2 , &StateTimes );
 

Python

Ret = ctypes.c_long()
Level1 = ctypes.c_long()
Level2 = ctypes.c_long()
StateTimes = ctypes.c_long()
Ret.value = caio.AioGetAiStopOutRange ( Id , 0 , ctypes.byref(Level1) , ctypes.byref(Level2) , ctypes.byref(StateTimes) )