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

Library Functions

4-1-9 ClkSetMessageOnArrival()

FINS Message Reception Notification Registration to Window

Function
Call Format
Arguments
Return Value
Description

4-1-10 ClkSetThreadMessageOnArrival()

FINS Message Reception Notification Registration to Thread

Function
Call Format
Arguments
Return Value
Description
Makes settings to notify the specified window with a Windows message when a
FINS message is received.
INT ClkSetMessageOnArrival(PCLKHANDLE hCLK, HWND hWnd, UINT
uMsg);
Type
PCLKHANDLE
HWND
UINT
CLK_SUCCESS is returned if the function ends normally.
CLK_ERROR is returned if the function ends in an error. Detailed error informa-
tion 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_WINDO-
WHANDLE_PARA: Window handle error)
The function will end in an error if an illegal value is specified for the window han-
dle specified as the argument. (Detailed error information = 67: Illegal window
handle)
The function will end in an error if the message specified in the argument is over
0x7FFF. (Detailed error information = ERR_MESSAGE_PARA: Message type
error)
The function will end in an error if a message has already been registered for
FINS message reception. (Detailed error information = 70: Duplicated message
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 informa-
tion can be obtained using ClkGetLastError().
Both ClkSetMessageOnArrival and ClkSetThreadMessageOnArrival cannot be
registered at the same time.
Variable name
hCLK The CLK handle obtained with
ClkOpen()
hWnd Window handle to receive event
notification
uMsg Message to use for notification
(WM_USER to 0x7FFF)
Variable name
hCLK The CLK handle obtained with
ClkOpen()
dwThreadId Thread ID to receive event notification
uMsg Message to use for notification
(WM_USER to 0x7FFF)
Section 4-1
Description
hCLK, DWORD
Description
53