The openldv api – Echelon OpenLDV User Manual

Page 23

Advertising
background image

OpenLDV Programmer’s Guide

15

The OpenLDV API

This section describes the functions included in the OpenLDV API. Table 3

summarizes these functions. See Structures and Enumerations for the Driver

API on page 42 for descriptions of the structures and enumerations used by the

OpenLDV API. See OpenLDV API Return Codes on page 44 for descriptions of

the return codes.

Table 3. OpenLDV API Functions

Function

Description

Added in

OpenLDV

Version

ldv_close()

Closes an open session.

1.0

ldv_free_device_info()

Releases the resources allocated by a

call to ldv_get_device_info() or

ldv_get_matching_devices().

2.0

ldv_free_driver_info()

Releases the resources allocated by a

call to ldv_get_driver_info().

2.0

ldv_free_matching_devices()

Releases the resources allocated by a

call to

ldv_get_matching_devices().

2.0

ldv_get_device_info()

Retrieves information about a

L

ON

W

ORKS

interface device.

2.0

ldv_get_driver_info()

Retrieves information about a

L

ON

W

ORKS

interface device driver

class.

2.0

ldv_get_matching_devices()

Retrieves information about the

L

ON

W

ORKS

interface devices that

match a set of capabilities.

2.0

ldv_get_version()

Retrieves the version number of the

OpenLDV API.

1.0

ldv_locate_sicb()

Locates the SICB portion of the data

within an LdvEx (or SICB)

formatted message, if present.

2.0

ldv_open()

Opens a network interface device.

1.0

ldv_open_cap()

An extended version of ldv_open()

and ldvx_open() that additionally

allows the caller to request specific

capabilities for the device.

2.0

Advertising