Table of Contents
Advertisement
Library Functions
4-1-8 ClkGetRingStatus()
Function
Call Format
Arguments
Return Value
Description
52
The read data size is fixed. Provide a memory area the size of the PNSTBUF-
FER structure as a read data storage buffer.
If the function is executed for a Board that is not part of a network, 0 will be set for
the following members of the read data structure.
Network participation status
Communications cycle time
Polling node address
Data link operation status and data link mode
Data link status
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 argu-
ment. (Detailed error information = ERR_NO_CLKUNIT: No CLK Unit)
The function will end in an error if a message reception area cannot be obtained
because
of
insufficient
ERR_NO_MEMORY: Memory acquisition error)
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 informa-
tion 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 PNSTBUF-
FER 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 argu-
ment. (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 Optical
Board
in
token
bus
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
ERR_NO_MEMORY: Memory acquisition error)
memory.
(Detailed
Optical Ring Status Read
Variable name
hCLK
The CLK handle obtained with
ClkOpen()
byNet
Network address of the Broad to read
the optical ring status for
pBuffer
Pointer to the buffer structure to store
the read data
mode.
(Detailed
memory.
(Detailed
Section
4-1
error
information
=
Description
error
information
=
error
information
=
Advertisement
Table of Contents
Troubleshooting
