AioGetAiStopOutRangeEx

Function

Retrieves the settings of Out Range comparison stop condition. The Out Range is stored in Voltage or Current.

Format

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

Parameters

Id [ VB.NET : Short ] [ C, C++ : short ] [ C# : short ] [ Python : ctypes.c_short ]
Specifies the ID retrieved from AioInit function.

AiChannel [ VB.NET : Short ] [ C, C++ : short ] [ C# : short ] [ Python : ctypes.c_short ]
Fixed to 0. (Reserved)

Level1 [ VB.NET : Single ] [ C, C++ : float * ] [ C# : out float ] [ Python : ctypes.POINTER(ctypes.c_float) ]
Specifies the address of the variable that stores the upper limit data of Out Range comparison. The data are stored in Voltage or Current.

Level2 [ VB.NET : Single ] [ C, C++ : float * ] [ C# : out float ] [ Python : ctypes.POINTER(ctypes.c_float) ]
Specifies the address of the variable that stores the lower limit data of Out Range comparison. The data are stored in Voltage or Current.

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

Return value

Ret [ VB.NET : Integer ] [ C, C++ : long ] [ C# : int ] [ 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.
12430	The value of AiChannel is outside the designated range of the function Specify the channel setting in range: 0 <= AiChannel <= Max channel.
12431	Pointer to Level1 is NULL Specify the address of variable to parameter.
12432	Pointer to Level2 is NULL Specify the address of variable to parameter.
12433	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.
22430	The value of AiChannel is outside the designated range of the device being used

Initial value

In all devices, AiChannel = 0, StateTimes = 1, Voltage or Current value equals to Level1, Level2 = 0 in binary.

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.

VB.NET	Dim Ret As Integer Dim Level1 As Single Dim Level2 As Single Dim StateTimes As Integer Ret = AioGetAiStopOutRangeEx ( Id , 0 , Level1 , Level2 , StateTimes )
C, C++	long Ret; float Level1; float Level2; long StateTimes; Ret = AioGetAiStopOutRangeEx ( Id , 0 , &Level1 , &Level2 , &StateTimes );
C#	int Ret; float Level1; float Level2; int StateTimes; Ret = aio.GetAiStopOutRangeEx ( Id , 0 , out Level1 , out Level2 , out StateTimes );
Python	Ret = ctypes.c_long() Level1 = ctypes.c_float() Level2 = ctypes.c_float() StateTimes = ctypes.c_long() Ret.value = caio.AioGetAiStopOutRangeEx ( Id , 0 , ctypes.byref(Level1) , ctypes.byref(Level2) , ctypes.byref(StateTimes) )