Openldv api return codes, Openldv, Api return codes – Echelon OpenLDV User Manual

Page 53

Advertising
background image

OpenLDV Programmer’s Guide

45

OpenLDV API Return Codes

Table 30 describes the return codes that can be returned by the OpenLDV API

functions. These codes are defined in the LDVCode enumeration.

Table 30. OpenLDV Return Codes

Return Code

Numeric

Value

Description

LDV_OK

0

The operation completed

successfully.

LDV_NOT_FOUND

1

This code is returned if you

call any of the open functions

to open a L

ON

W

ORKS

interface

device, but you do not specify

a valid device name as the id

parameter, or the device

referenced by the id

parameter cannot be found.
This code is also returned for

the ldv_locate_sicb()

function if an LdvEX packet

does not contain an SICB

message.

LDV_ALREADY_OPEN

2

This return code is obsolete.

LDV_NOT_OPEN

3

The L

ON

W

ORKS

interface

device is not open. This code is

returned if you use the

ldv_read() or ldv_write()

functions to read or write a

message to a network

interface device, or if you use

the ldv_close() function to

close a session with a network

interface, and the network

interface has not yet been

opened with the ldv_open()

function (or the network

interface has already been

closed).

Advertising