Clkclose(); Board Close; Clksendfins(); Fins Message Send - Omron SYSMAC 3G8F7-CLK13-E Operation Manual

Library Functions
Supplemental Information
4-1-2

ClkClose()

Function
Call Format
Arguments
Return Value
Description
4-1-3

ClkSendFins()

Function
Call Format
Arguments
Return Value
Description
The unit address is different from the board ID on the Support Board.
It is not normally necessary to specify a unit address when sending a com-
mand from an application running on the computer and receiving a response.
Always specify the unit address when sending a command to the application
from an application running on a computer or from a PC at a different node.
Opens the application interface and gets a CLK handle.
INT ClkClose(PCLKHANDLE hCLK);
Type
PCLKHANDLE
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().
If the application is ended without using ClkClose(), the address specified for
ClkOpen() cannot be used again. Always execute ClkClose() for all CLK han-
dles obtained with ClkOpen() before ending the application.
Sends a FINS message.
INT ClkSendFins(PCLKHANDLE hCLK, PCLKHEADER pHeader, LPVOID
lpMessage, DWORD dwSize);
Type
PCLKHANDLE
PCLKHEADER
LPVOID
DWORD
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().
Refer to Structure Descriptions for information on the header information
structure.
Store the FINS message from the command code (MRC) on in the FINS mes-
sage send buffer.
The amount of data that can be sent and received will be limited by the type of
networks through which the message must pass. The largest value that the
send buffer (dwSize) can be set to is 1,998 bytes. The limit when passing
through a SYSMAC LINK Network is 542 bytes.
If SID is –1, autoincrementing will be used for the SID. (There is only one SID
memory area for each process when automatically incrementing functions
internally. There are not separate areas for each network handle or thread.)
The function will end in an error if a FINS message send buffer size of less
than 2 bytes is specified in the argument. (Detailed error information =
ERR_SEND_BUFFER_SIZE: Send message size error)
Variable name
hCLK The CLK handle obtained with ClkO-
pen()

FINS Message Send

Variable name
hCLK The CLK handle obtained with ClkO-
pen()
pHeader Pointer to the header information struc-
ture for the FINS message
lpMessage Pointer to the send buffer for the FINS
message
dwSize Size of FINS message send buffer
Section 4-1

Board Close

Description
Description
57