Clkgetnetworkstatus(); Network Status Read - Omron SYSMAC 3G8F7-CLK13-E Operation Manual

Library Functions
4-1-7

ClkGetNetworkStatus()

Function
Call Format
Arguments
Return Value
Description
60
The function will end in an error if access is requested to 3 or more different
memory areas for one CLK handle. (Detailed error information =
ERR_MEMORY_AREA: Multiple memory area specification error)
The function will end in an error if a memory name specified in the argument
does not exist. (Detailed error information = ERR_NO_MEM_TYPE: No such
memory)
Reads the network status.
INT ClkGetNetworkStatus(PCLKHANDLE hCLK, BYTE byNet, PNST-
BUFFER pBuffer);
Type
PCLKHANDLE
BYTE
PNSTBUFFER
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.
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 argument. (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 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).

Network Status Read

Variable name
hCLK The CLK handle obtained with ClkO-
pen()
byNet Network address of the Broad to read
network status
pBuffer Pointer to the buffer structure to store
the read data
Section 4-1
Description