AioGetAiStopLevel


Function

Retrieves the level when the stop condition is level comparison.

Format

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

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)

AiStopLevel [ VB.NET : Integer ] [ C, C++ : long * ] [ C# : out int ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the variable that stores the level comparison data. The data are stored in binary value.

AiDirection [ VB.NET : Short ] [ C, C++ : short * ] [ C# : out 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 [ 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.

11310

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

11311

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

11312

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.

21300

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

AiStopLevel = 800H

Resolution of device is 16 bit

AiStopLevel = 8000H

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 for channel 0.

VB.NET

Dim Ret As Integer
Dim AiStopLevel As Integer
Dim AiDirection As Short
Ret = AioGetAiStopLevel ( Id , 0 , AiStopLevel , AiDirection )
 

C, C++

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

C#

int Ret;
int AiStopLevel;
short AiDirection;
Ret = aio.GetAiStopLevel ( Id , 0 , out AiStopLevel , out AiDirection );
 

Python

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

See also

AioSetAiStopLevel