Ldv_get_matching_devices(), Ldv_get_version, Syntax – Echelon OpenLDV User Manual

Page 30: Remarks

Advertising
background image

22

Using the OpenLDV API

ldv_get_matching_devices()

Call this function to retrieve information about all L

ON

W

ORKS

interface devices

that match a set of capabilities.

Syntax

LDVCode ldv_get_matching_devices(

LDVDeviceCaps nCaps,

LDVCombineFlags nCombine,

LDVDevices* pDevices

)

Table 10. ldv_get_matching_devices() Parameters

Parameter

Direction Description

nCaps

Input

An LDVDeviceCaps value for the device capabilities to

match.

nCombine

Input

The criterion for how the match should be performed. The

criterion is a bitwise combination of one of the

LdvCombineFlags values.

pDevices

Output

A pointer to an LDVDevices structure for the devices whose

capabilities match those requested.

Remarks

Use this function to retrieve information about all L

ON

W

ORKS

interface devices

that match a specified set of device capabilities. This function returns LDV_OK

if the device information is successfully retrieved. After you retrieve the device

information, you must free the device information resources by calling the

ldv_free_matching_devices() function. Do not call the

ldv_free_device_info() function for each retrieved device.
The contents of the returned structure should be treated as constant (read-only)

and cannot be modified.
See Structures and Enumerations for the Device API on page 37 for a description

of the LDVDevices and LDVDeviceCaps structures and the

LdvCombineFlags enumeration.

ldv_get_version

Call this function to read the version number of the OpenLDV driver.

Syntax

LPCSTR ldv_get_version(

VOID

)

Advertising