Ldv_xlate_device_name(), Remarks – Echelon OpenLDV User Manual

Page 41

Advertising
background image

OpenLDV Programmer’s Guide

33

Table 18. ldv_write() Parameters

Parameter

Direction Description

handle

Input

The L

ON

W

ORKS

interface device to be written. This value

was returned as the handle parameter when you opened the

network interface with one of the open functions

(ldv_open(), ldv_open_cap(), or ldvx_open()).

msg_p

Input

A pointer to a buffer that contains the message to be written

to the network interface.
For information about the different message commands that

you can send with this function, and descriptions of the

application buffer structure that each one requires, see

Chapter 3, Sending and Receiving Messages with the

OpenLDV API, on page 57.

len

Input

The length of the message to be written. This length might

not match the length of buffer referenced by the msg_p

parameter. The len parameter should reflect how many

bytes will be written to the network interface, and should

therefore be less than or equal to the length of the buffer

referenced by the msg_p parameter.

Remarks

This function returns LDV_OK if the message is successfully written to the

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 it is a local network

interface. If it is a remote network interface, the LDVX_WRITE_FAILED code

is returned.
Be sure to use the message format (SICB or LdvEx) that corresponds to the

format specified when the network interface was opened.

ldv_xlate_device_name()

Call this function to retrieves the physical name of the Windows device that is

associated with a (logical) network interface name.
Legacy device drivers (for example, for PCC-10 or PCLTA-21 network interfaces)

can use the translated name to access the driver directly. In general, however,

using the translated name is not recommended.

Advertising