AioSetAiCallBackProc

Function

Registers the callback function that is called when the events relative to analog input raise.

Format

Ret = AioSetAiCallBackProc ( Id , CallBackProc , AiEvent , Param)

Parameters

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

CallBackProc [ C, C++ : long * ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the callback function.

AiEvent [ C, C++ : long ] [ Python : ctypes.c_long ]
Specifies the event factor from the following range in macro or value that calls the callback function.
AiEvent has the following meanings in bit, it can be specified by a combination of these bits.

The available event factor is based on whether the device buffer is used or whether the user buffer is used.

When "Event that the specified number of data are stored" is used, set the number of samplings that raises the event by using the AioSetAiEventSamplingTimes function.

Param [ C, C++ : void * ] [ Python : ctypes.c_void_p ]
Specifies the parameter address passed to the callback function.
If the parameter isn't necessary, specify NULL.

Return value

Ret [ C, C++ : long ] [ Python : ctypes.c_long ]

Remarks

Registers the callback function using in this function, the callback function is called when any event raised in the device.

This function cannot be used on devices without the analog input function.
If the device is in operation, the function cannot be performed.

When AioStopAi function is performed, the callback function isn't called.

You should not execute the functions that start/stop devices operation in the callback routine.

For Ethernet devices
    If communication with the device is lost, the process will be unregistered and will no longer receive event notifications.
    If you want to perform event notification again, please make the settings again using this function.

Example

Registers the callback function in "Event that device operation end" and "Event that the specified number of data are output" factor.

See also

Callback Function

Format

Ret = CallBackProc ( Id , Message , wParam , lParam , Param )

Parameters

Id [ C, C++ : short ] [ Python : ctypes.c_short ]
The ID retrieved from AioInit is passed

Message [ C, C++ : short ] [ Python : ctypes.c_short ]
The message ID is passed that cause the callback function to be called.
Message ID is any of the following value.

wParam [ C, C++ : long ] [ Python : ctypes.c_long ]
The parameter is passed from the driver. It isn't used now.

lParam [ C, C++ : long ] [ Python : ctypes.c_long ]
The parameter peculiar to event is passed.

Param [ C, C++ : void * ] [ Python : ctypes.c_void_p ]
The parameter specified in the function AioSetAiCallBackProc is passed.
NULL is stored in this when NULL is specified in the parameter.