AioGetControlFilter

Function

Retrieves the digital filter value set to the external control signal.

Format

Ret = AioGetControlFilter ( Id , Signal , Value )

Parameters

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

Signal [ VB.NET : Short ] [ C, C++ : short ] [ C# : short ] [ Python : ctypes.c_short ]
Specifies the external control signal for retrieving filter value.
For Z-series devices such as AI-1204Z-PCI, 0, 1, 2 or -1 can be setted. Other devices are fixed at -1.

External control signal	Macro	Value
Analog input external clock	AIO_AIF_CLOCK	0
Analog input external start trigger	AIO_AIF_START	1
Analog input external stop trigger	AIO_AIF_STOP	2
Analog output external clock (Reserved)	AIO_AOF_CLOCK	3
Analog output external start trigger (Reserved)	AIO_AOF_START	4
Analog output external stop trigger (Reserved)	AIO_AOF_STOP	5
All signals above	AIO_ALLF	-1

Value [ VB.NET : Single ] [ C, C++ : float * ] [ C# : out float ] [ Python : ctypes.POINTER(ctypes.c_float) ]
Specifies the address of the variable that stores the filter time. The unit is usec.
0 means no filter.

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.
10350	The value of Signal is outside the designated range of the function
10351	Pointer to Value 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 and output, counter, timer 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.
20350	The value of Signal is outside the designated range of the device being used

Initial value

For all signal lines, filter is disabled

Remarks

The function cannot be performed, if device is in operation.

Example

Retrieves the filter values set for all control signals.

VB.NET	Dim Ret As Integer Dim Value As Single Ret = AioGetControlFilter ( Id , -1 , Value )
C, C++	long Ret; float Value; Ret = AioGetControlFilter ( Id , -1 , &Value );
C#	int Ret; float Value; Ret = aio.GetControlFilter ( Id , -1 , out Value );
Python	Ret = ctypes.c_long() Value = ctypes.c_float() Ret.value = caio.AioGetControlFilter ( Id , -1 , ctypes.byref(Value) )