TimTimerCallBackProc


Function

Registers the callback function, it will be called when the event occurred by the interval timer setting with the TimStartTimer function.

Format

Ret = TimTimerCallBackProc(TimerId, CallBackProc, Param)

Parameters

TimerId [ VB.Net: Integer ] [ C, C++: short ] [ C++/CLI: short ] [ C#: out short ]

Returns an ID that is the Interval Timer identifier.

 

CallBackProc [ VB.Net: IntPtr ] [ C, C++: long * ] [ C++/CLI: IntPtr ] [ C#: IntPtr ]

Specify the address of the callback function.

If NULL is specified, the notification setting of callback is cleared.

 

Param [ VB.Net: IntPtr ] [ C, C++: void * ] [ C++/CLI: void * ] [ C#: void * ]

Specify the address of the parameter that will be passed to the callback function. If parameter is unnecessary, specify it to NULL.
 

Return Value

Ret [ VB.NET: Integer ] [ C, C++: long ] [ C#: int ]

Definition

Value

Description

TIM_ERR_SUCCESS

0

Normal completed

TIM_ERR_DLL_INVALID_ID

10001

Invalid ID specified.

Please confirm whether the initialization function has completed normally.

TIM_ERR_DLL_NOT_INITIALIZED

10010

It is not initialized. Please confirm whether the initialization function has completed normally.

TIM_ERR_DLL_CALLBACK

10400

Invalid callback function address.

The others (See also:Details of Error Code)

Initial Value

None

Remarks

Use this function to register the callback function, then the callback function will be called when the interval timer event occurred.

Though the operation of the callback function is similar to an event, it is different from an event that the window handle is not necessary for it, so the application without a window also can use it.

This function is used to perform the interval timer notification set by the TimStartTimer function from the callabck function.

Therefore, it is necessary to set interval timer condition using the TimStartTimer function first.

In addition, use the TimStopTimer function to stop interval timer function.

 


Callback Function

Format

void CallBackProc( TimerId , wParam , lParam , Param )

Parameters

TimerId [ VB.NET: short ] [ C, C++: short ] [ C++/CLI: short ] [ C#: short ]

Pass the ID retrieved from TimStartTimer.

 

wParam [ VB.NET: Integer ] [ C, C++: WPARAM ] [ C++/CLI: long ] [ C#: int ]

The parameter is passed by the driver. It doesn't use it now.

 

lParam [ VB.NET: Integer ] [ C, C++: WPARAM ] [ C++/CLI: long ] [ C#: int ]

The parameter is passed by the driver. It doesn't use it now.

 

Param [ VB.NET: IntPtr ] [ C, C++: void * ] [ C++/CLI: void * ] [ C#: void * ]

The parameter specified by the TimTimerCallBackProc function is passed.

It will be NULL when the Param parameter was specified to NULL.

Return Value

None

See Also

TimStartTimer