Impulse 463E - Manual (Page 92)

© Sealevel Systems, Inc. - 89 - SeaI/O User Manual
CEthernet API
The API to CCEthernet is easy to use, straightforward, and designed to be as user-
friendly as possible. Looking at the UML diagram, one can determine that there are
only six functions that the interface provides. Of those, only four are required for
basic operation. Sample code segments are provided in a later section. Each of the
methods are documented below, including the parameters and the associated return
codes.
+CCEthernet()
+~CCEthernet()
+Alloc(in number : int)
+find_devices(in type_to_find : ceth_device_type, in number_to_find : int, inout list_to_store_devices : ceth_device *)
+Free(inout list : ceth_device *)
+get_number_of_interfaces()
+isWinsockInitialized()
-prepareList(inout c : ceth_device *, in n : int)
+set_information(inout device : ceth_device *, in command : ceth_set_types, in ... : ...)
-array
+CE
-objs
CCEthernet
UML Class Model for CCEthernet
find_devices
Parameters
type_to_find
− Can be: SeaIO_Ethernet, SeaLink_Dev, or Sealevel_All_Devices.
number_to_find
− number <= number allocated using Alloc().
list_to_store_devices
− pointer to the list previously allocated.
Return Values
-100XX
− Socket Error. Refer to Winsock documentation for error code.