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

Page 40

Advertising
background image

32

Using the OpenLDV API

Table 17. ldv_set_driver_info() Parameters

Parameter

Direction Description

nDriverId

Input

The driver ID of the driver that you are creating or

modifying.

pDriverInfo

Input

A pointer to an LDVDriverInfo structure that contains the

information for the created or modified driver.

Remarks

Use this function to create or modify information for a L

ON

W

ORKS

interface

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

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

LDV_DRIVER_INFO_INVALID, LDV_DRIVER_UPDATE_FAILED, or

LDV_STD_DRIVER_TYPE_READ_ONLY).
Before you call this function, you must initialize the LDVDriverInfo structure:

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

The id field is ignored by this function. The driver ID is read only, and

cannot be modified using this function.

Set the type field to an LdvDriverType value that corresponds to the

new driver type, or set it to -1 if the driver type is not to be modified. The

driver type is read-only for standard driver IDs, and cannot be modified

using this function; however, non-standard drivers can have their driver

type set.

Set the name field to the name of the new driver type, or set it to NULL

or an empty string if the driver name is not to be modified.

Set the desc field to the description of the new driver type, or set it to

NULL or an empty string if the driver description is not to be modified.

See Structures and Enumerations for the Driver API on page 42 for a description

of the LDVDriverID enumeration values and the LDVDriverInfo structure.
See Working with a Custom Network Interface on page 148 for an example of how

to use this function.

ldv_write()

Call this function to write a message to the network interface, or to send a

message through the network interface to a device on the network.

Syntax

LDVCode ldv_write(

LdvHandle handle,

PVOID msg_p,

SHORT len

)

Advertising