AioGetAiSamplingDataSize

Function

When the user buffer mode is used to transfer data, retrieves data size that is necessary for one sampling.
This data size is decided by the used number of channels and the attached data settings on the device that uses bus-master transfer.
Therefore, you need set the number of channels (AioSetAiChannels) and the Attached data before retrieve the data size by this function.

Format

Ret = AioGetAiSamplingDataSize ( Id , DataSize )

Parameters

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

DataSize [ VB.NET : Short ] [ C, C++ : short * ] [ C# : out short ] [ Python : ctypes.POINTER(ctypes.c_short) ]
Specifies the address of the variable that stores the data size.
Data size is stored as the number of packets. 1 packet = 4 bytes.

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.
12020	Pointer to DataSize 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.

Initial value

In all devices, DataSize = 1

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 data size that is necessary for one sampling.

VB.NET	Dim Ret As Integer Dim DataSize As Short Ret = AioGetAiSamplingDataSize ( Id , DataSize )
C, C++	long Ret; short DataSize; Ret = AioGetAiSamplingDataSize ( Id , &DataSize );
C#	int Ret; short DataSize; Ret = aio.GetAiSamplingDataSize ( Id , out DataSize );
Python	Ret = ctypes.c_long() DataSize = ctypes.c_short() Ret.value = caio.AioGetAiSamplingDataSize ( Id , ctypes.byref(DataSize) )