Omron SYSMAC 3G8F7-CLK12-E, Руководство по эксплуатации

Страница: 64 / 166

4-1 Section Library Functions
48
4-1 Library Functions
This section describes the library functions used for the Control Link Support
Boards for PCI bus. Refer to Section 3 Creating Applications Using the C Library
for application methods.
Functions
Function name Name Function Page
ClkOpen Board Open Opens the application interface and gets
a CLK handle. 48
ClkClose Board Close Closes the application interface and
releases the CLK handle. 49
ClkSendFins FINS Message Send Sends a FINS message. 49
ClkRecvFins FINS Message Receive Receives a FINS message. 49
ClkWriteDatalink Data Link Data Write Writes data to a data link area. 50
ClkReadDatalink Data Link Data Read Reads data from a data link area. 51
ClkGetNetworkStatus Network Status Read Reads the network status. 51
ClkGetRingStatus Optical Ring Status Read Reads the optical ring status. 52
ClkSetMessageOnArrival FINS Message Reception
Notification Registration to
Window Makes settings to notify the specified
window with a Windows message when
a FINS message is received. 53
ClkSetThreadMessageOnArrival FINS Message Reception
Notification Registration to
Thread Makes settings to notify the specified
thread with a Windows message when a
FINS message is received. 53
ClkClearMessageOnArrival FINS Message Reception
Notification Clear Clears windows message notification
when a FINS message is received. 55
ClkGetLastError Detailed Error Information
Acquire Gets an error code generated when a
CLK library function is used. 55
4-1-1 ClkOpen() Board Open
Opens the application interface and gets a CLK handle.
PCLKHANDLE ClkOpen( BYTE byAppUnitAdr, INT *piRetErr);
Type Variable name Description
BYTE byAppUnitAdr Unit address allocated to the application
INT* piRetErr Error information for ClkOpen()
A CLK handle is returned if the function ends normally.
CLK_ERROR is returned if the function ends in an error. Detailed error informa-
tion is stored in piRetErr.
Set a value between 1 and 15 for AppUnitAdr. Set 0 when it is not necessary to
set a specific application unit address. An unused unit address will be automati-
cally allocated.
The function will end in an error if a Controller Link Support Board is not
mounted.(Detailed error information = ERR_NO_CLKUNIT: No CLK Unit)
The function will end in an error if a handle cannot be obtained because of insuffi-
cient memory. (Detailed error information = ERR_NO_MEMORY: Memory ac-
quisition error)
The function will end in an error if the unit address specified in the argument is
not between 0 and 15. (Detailed error information = ERR_UNIT_ADDRESS:
Unit address range error)
The unit address is different from the board ID on the Support Board.
It is not normally necessary to specify a unit address when sending a command
from an application running on the computer and receiving a response. Always
specify the unit address when sending a command to the application from an
application running on a computer or from a PLC at a different node.
Function
Call Format
Arguments
Return Value
Description
Supplemental
Information