AioGetTmEvent


Function

Retrieves the event factor for window message notification relative to interval timer.

Format

Ret = AioGetTmEvent ( Id , TimerId , hWnd , TmEvent )

Parameters

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

TimerId [ VB.NET : Short ] [ C, C++ : short ] [ C# : short ] [ Python : ctypes.c_short ]
Specifies the timer ID.

hWnd [ VB.NET : IntPtr ] [ C, C++ : HWND * ] [ C# : out IntPtr ] [ Python : ctypes.POINTER(ctypes.wintypes.HANDLE) ]
Specifies the address of the variable that stores the window handle.
If the handle needn't be retrieved, please specify NULL to it.

TmEvent [ VB.NET : Integer ] [ C, C++ : long * ] [ C# : out int ] [ Python : ctypes.POINTER(ctypes.c_long) ]
Specifies the address of the variable that stores the event factor.
TmEvent has the following meanings in bit.

Event factor

Macro

Value

Event that interval elapses

TME_INT

00000001H

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.

16010

The value of TimerId is outside the designated range of the function

16011

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

20001

This function can't be used by this device
This function cannot be used in the device without this functionality.

20002

Can not use while by another device works

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.

26010

The value of TimerId is outside the designated range of the device being used

Initial value

TmEvent = 0 for all devices

Remarks

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

Example

Retrieves the event factor of the message notification for Timer ID 0.

VB.NET

Dim Ret As Integer
Dim hWnd As IntPtr
Dim TmEvent As Integer
Ret = AioGetTmEvent ( Id , 0 , hWnd , TmEvent )
 

C, C++

long Ret;
HWND hWnd;
long TmEvent;
Ret = AioGetTmEvent ( Id , 0 , &hWnd , &TmEvent );
 

C#

int Ret;
IntPtr hWnd;
int TmEvent;
Ret = aio.GetTmEvent ( Id , 0 , out hWnd , out TmEvent );
 

Python

Ret = ctypes.c_long()
handle = ctypes.windll.user32.FindWindowW(0, "Interrupt")
TmEvent = ctypes.c_long()
Ret.value = caio.AioGetTmEvent ( Id , 0 , ctypes.byref(handle) , ctypes.byref(TmEvent) )
 

See also

AioSetTmEvent