Clksetthreadmessageonarrival(); Fins Message Reception Notification Registration To Thread - Omron SYSMAC 3G8F7-CLK13-E Operation Manual

Library Functions
Description

4-1-10 ClkSetThreadMessageOnArrival()

FINS Message Reception Notification Registration to Thread

Function
Call Format
Arguments
Return Value
Description
62
Both ClkSetMessageOnArrival and ClkSetThreadMessageOnArrival cannot
be registered at the same time.
The function will end in an error if a null pointer is specified for the window
handle specified as the argument. (Detailed error information =
ERR_WINDOWHANDLE_PARA: Window handle error)
The function will end in an error if an illegal value is specified for the window
handle specified as the argument. (Detailed error information = 67: Illegal win-
dow handle)
The function will end in an error if the message specified in the argument is
over 0x7FFF. (Detailed error information = ERR_MESSAGE_PARA: Mes-
sage type error)
The function will end in an error if a message has already been registered for
FINS message reception. (Detailed error information = 69: Duplicated mes-
sage registration error)
Makes settings to notify the specified thread with a Windows message when a
FINS message is received.
INT ClkSetThreadMessageOnArrival(PCLKHANDLE
dwThreadId, UINT uMsg);
Type
PCLKHANDLE
DWORD
UINT
CLK_SUCCESS is returned if the function ends normally.
CLK_ERROR is returned if the function ends in an error. Detailed error infor-
mation can be obtained using ClkGetLastError().
Both ClkSetMessageOnArrival and ClkSetThreadMessageOnArrival cannot
be registered at the same time.
The function will end in an error if a null pointer is specified for the window
handle specified as the argument. (Detailed error information =
ERR_WINDOWHANDLE_PARA: Window handle error)
The function will end in an error if an illegal value is specified for the window
handle specified as the argument. (Detailed error information = 67: Illegal win-
dow handle)
The function will end in an error if the message specified in the argument is
over 0x7FFF. (Detailed error information = ERR_MESSAGE_PARA: Mes-
sage type error)
The function will end in an error if a message has already been registered for
FINS message reception. (Detailed error information = 69: Duplicated mes-
sage registration error)
Variable name
hCLK The CLK handle obtained with ClkO-
pen()
dwThreadId Thread ID to receive event notification
uMsg Message to use for notification
(WM_USER to 0x7FFF)
Section 4-1
hCLK, DWORD
Description