Clkgetringstatus(); Optical Ring Status Read; Clksetmessageonarrival() Fins Message Reception Notification Registration To Window - Omron SYSMAC 3G8F7-CLK13-E Operation Manual

Controller link support boards for pci bus
Table of Contents

Advertisement

Library Functions
4-1-8

ClkGetRingStatus()

Function
Call Format
Arguments
Return Value
Description
4-1-9
ClkSetMessageOnArrival()
FINS Message Reception Notification Registration to Window
Function
Call Format
Arguments
Return Value
Reads the optical ring status.
INT ClkGetRingStatus(PCLKHANDLE hCLK, BYTE byNet, PRINGBUFFER
pBuffer);
Type
PCLKHANDLE
BYTE
PRINGBUFFER
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 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).
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 infor-
mation can be obtained using ClkGetLastError().

Optical Ring Status Read

Variable name
hCLK
The CLK handle obtained with ClkO-
pen()
byNet
Network address of the Broad to read
the optical ring status for
pBuffer
Pointer to the buffer structure to store
the read data
Variable name
hCLK
The CLK handle obtained with ClkO-
pen()
hWnd
Window handle to receive event notifi-
cation
uMsg
Message to use for notification
(WM_USER to 0x7FFF)
Section 4-1
Description
Description
61

Advertisement

Table of Contents
loading

Table of Contents