Ldv_set_device_info(), Syntax, Remarks – Echelon OpenLDV User Manual

Page 38

Advertising
background image

30

Using the OpenLDV API

To de-register a current event and register a new event, call

ldv_register_event()with a new event parameter. You can also call the

ldv_register_event() function and specify NULL as the event parameter to

disable event notifications for a network interface.
If the handle parameter is not valid, the LDV_INVALID_DEVICE_ID code is

returned. If the network interface referenced by the handle parameter is not

open, then the LDV_NOT_OPEN code is returned. If the function fails to

register the Windows event object, the LDVX_REGISTER_FAILED code is

returned.

ldv_set_device_info()

Call this function to create or modify the information for a specified L

ON

W

ORKS

interface device. Applications that configure network interfaces (such as the

Echelon L

ON

W

ORKS

Interfaces control panel application) can use this function.

Syntax

LDVCode ldv_set_device_info(

LPCSTR

szDevice

,

const LDVDeviceInfo* pDeviceInfo

)

Table 16. ldv_set_device_info() Parameters

Parameter

Direction Description

szDevice

Input

The name of the L

ON

W

ORKS

interface device that you are

creating or modifying.

pDeviceInfo

Input

A pointer to an LDVDeviceInfo structure that contains the

information for the created or modified device.

Remarks

Use this function to create or modify information for a L

ON

W

ORKS

interface

device. This function returns LDV_OK if the device information is successfully

updated. Otherwise, it returns a failure code (such as

LDV_DEVICE_INFO_INVALID).
Before you call this function, you must initialize the LDVDeviceInfo structure:

Set the size field equal to the size of the LDVDeviceInfo structure.

The driver field is ignored by this function. Use the driverId field to

specify the driver for the device.

The name field is ignored by this function. The logical name of the device

is read only and cannot be modified by this function.

Set the physName field to the physical name of the new device, or set it to

NULL or an empty string if the physical device name is not to be

modified. For a custom network interface that uses a Windows driver,

Advertising