AioGetAiEventSamplingTimes


Function

Retrieves the number of samplings when "Event that the specified number of data are stored" is used.
This settings is necessary when the transfer mode of the conversion data that is set by AioSetAiTransferMode function is Device buffer mode.
This function needn't be executed if the transfer mode of the conversion data is User buffer.

Format

Ret = AioGetAiEventSamplingTimes ( Id , AiSamplingTimes )

Parameters

Id [ C, C++ : short ] [ Python : ctypes.c_short ]
Specifies the Device ID retrieved from AioInit function.

AiSamplingTimes [ C, C++ : long * ] [ Python : ctypes.POINTER(ctypes.c_long) ]
If the event factor is AIE_DATA_NUM, specifies the address of the variable that stores the number of samplings when the event raises.

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.

11410

Pointer to AiSamplingTimes 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, AiSamplingTimes = 500

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 number of samplings when "Event that the specified number of data are stored" is used.

C, C++

long Ret;
long AiSamplingTimes;
Ret = AioGetAiEventSamplingTimes ( Id , &AiSamplingTimes );
 

Python

Ret = ctypes.c_long()
AiSamplingTimes = ctypes.c_long()
Ret.value = caio.AioGetAiEventSamplingTimes ( Id , ctypes.byref(AiSamplingTimes) )
 

See also

AioSetAiEventSamplingTimes