![background image](http://html.mh-extra.com/html/omron/sysmac-3g8f7-clk12-ev1/sysmac-3g8f7-clk12-ev1_operation-manual_1633421078.webp)
58
Library Functions
Section 4-1
The function will end in an error if SID is not set to between –1 and 255. The
error code will be 39 (SID setting error).
4-1-4
ClkRecvFins()
FINS Message Receive
Function
Receives a FINS message.
Call Format
INT ClkRecvFins(PCLKHANDLE hCLK, PCLKHEADER pHeader, LPVOID
lpMessage, DWORD dwSize, DWORD dwTimeLimit);
Return Value
The size of the FINS message that was receive is returned as the number of
bytes 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().
Description
The number of receive bytes in the return value is for all bytes starting from
the command code (MCR) in the FINS message.
Refer to
Structure Descriptions
for information on the header information
structure.
The FINS message from the command code (MRC) on will be stored in the
FINS message receive buffer.
The function will end in an error if a FINS message receive buffer size of less
than 2 bytes is specified in the argument. (Detailed error information =
ERR_RECV_BUFFER_SIZE: Receive message size error)
The function will end in an error if a message reception area cannot be
obtained because of insufficient memory. (Detailed error information =
ERR_NO_MEMORY: Memory acquisition error)
The function will end in an error if the reception wait time is set to 0 and a
FINS message has not yet been received. (Detailed error information = 38:
Receive timeout)
The function will end in an error if the reception wait time elapses without
receiving a FINS message. (Detailed error information = 38: Receive timeout)
The function will end in an error if the received FINS message is larger than
the reception buffer size. The portion of the FINS message that fits will be
stored in the reception buffer. (Detailed error information =
ERR_MSG_SIZE_OVER: Receive buffer size error)
Type
Variable name
Description
PCLKHANDLE
hCLK
The CLK handle obtained with ClkO-
pen()
PCLKHEADER
pHeader
Pointer to the header information struc-
ture for the FINS message
LPVOID
lpMessage
Pointer to the receive buffer for the
FINS message
DWORD
dwSize
Size of FINS message receive buffer
DWORD
dwTimeLimit
Reception wait time (unit: ms)
Arguments
Summary of Contents for SYSMAC 3G8F7-CLK12-EV1
Page 2: ......
Page 4: ...iv ...
Page 20: ...xx Conformance to EC Directives 6 ...
Page 48: ...28 Applications Precautions Section 1 4 Example CX Programmer Response Timeout Setting ...
Page 68: ...48 Backup Power Supply Wiring Optical Ring Systems Only Section 2 4 ...
Page 74: ...54 Using the C Library Section 3 2 ...
Page 110: ...90 Changing the Data Link Tables with Active Data Links Section 5 5 ...
Page 187: ......