Echelon OpenLDV User Manual download pdf (Page 46)

38 Using the OpenLDV API

/* (read-only) */

typedef const LDVDeviceInfo* LDVDeviceInfoPtr;

The LDVDeviceInfo structure contains information that describes a specific

ONWORKS interface device (identified by its name). Table 22 describes the

LDVDeviceInfo structure’s fields.

Table 22. LDVDeviceInfo Structure

Field Description

size The size (in bytes) of this structure. This field must be set

before calling any of the set functions that pass this structure as

a parameter.

driver A pointer to a driver information object that describe the driver

for the device. See the LDVDriverInfo in Structures and

Enumerations for the Driver API on page 42.

Ignored by the ldv_set_device_info() function.

name A string that contains the name of the logical device.

physName A string that contains the name of the physical device, if

applicable. If not applicable, returns the logical name.

desc A string that contains the description of the device driver, if

available.

caps A combination of LDVDeviceCaps values that describes the

capabilities of this device, where known. See LDVDeviceCaps

in Table 25.

capsMask A combination of LDVDeviceCaps values that describes which

of the capability bits are valid. See LDVDeviceCaps in Table

25.

transId The transceiver ID of the device, if known.

A value of -1 signifies “unknown” or “don’t change”.

driverId The device driver ID of the associated driver. See LdvDriverID

in Table 27.

See the following functions for their use of this structure: ldv_get_device_info()

on page 20, ldv_set_device_info() on page 30, and ldv_free_device_info() on page

18.

LDVDevices Structure

The device API functions refer to the LDVDevices structured data type:

1 2 ... 41 42 43 44 45 46 47 48 49 50 51 ... 193 194

No comments

Echelon OpenLDV User Manual Page 46