![background image](http://html.mh-extra.com/html/omron/sysmac-3g8f7-clk12-ev1/sysmac-3g8f7-clk12-ev1_operation-manual_1633421081.webp)
61
Library Functions
Section 4-1
4-1-8
ClkGetRingStatus()
Optical Ring Status Read
Function
Reads the optical ring status.
Call Format
INT ClkGetRingStatus(PCLKHANDLE hCLK, BYTE byNet, PRINGBUFFER
pBuffer);
Return Value
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().
Description
Refer to
Structure Descriptions
for information on the read data structure.
The read data size is fixed. Provide a memory area the size of the PNST-
BUFFER structure as a read data storage buffer.
The function will end in an error if an error response code is returned for the
FINS message. (Detailed error information = ERR_RESPONSE: Error
response code error)
The function will end in an error if a Controller Link Support Board is not
mounted for the network specified by the Board network address specified as
an argument. (Detailed error information = ERR_NO_CLKUNIT: No CLK Unit)
The function will end in an error if it is executed for a Wired Board or an Opti-
cal Board in token bus mode. (Detailed error information =
ERR_NOT_RING_MODE: Wrong operating mode)
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 a network address of 0 is specified when
there is more than one network. (Detailed error information =
ERR_NETWORK_ADDRESS).
4-1-9
ClkSetMessageOnArrival()
FINS Message Reception Notification Registration to Window
Function
Makes settings to notify the specified window with a Windows message when
a FINS message is received.
Call Format
INT ClkSetMessageOnArrival(PCLKHANDLE hCLK, HWND hWnd, UINT
uMsg);
Return Value
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().
Type
Variable name
Description
PCLKHANDLE
hCLK
The CLK handle obtained with ClkO-
pen()
BYTE
byNet
Network address of the Broad to read
the optical ring status for
PRINGBUFFER
pBuffer
Pointer to the buffer structure to store
the read data
Arguments
Type
Variable name
Description
PCLKHANDLE
hCLK
The CLK handle obtained with ClkO-
pen()
HWND
hWnd
Window handle to receive event notifi-
cation
UINT
uMsg
Message to use for notification
(WM_USER to 0x7FFF)
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: ......