Ndreaddatabylocalidentifier, Ndreaddatabylocalidentifier -46 – National Instruments CAN 372139B-01 User Manual

Page 210

Advertising
background image

Chapter 6

Automotive Diagnostic Command Set API for C

Automotive Diagnostic Command Set User Manual

6-46

ni.com

ndReadDataByLocalIdentifier

Purpose

Executes the ReadDataByLocalIdentifier service. Reads an ECU data record.

Format

long ndReadDataByLocalIdentifier(

TD1 *diagRef,

unsigned char localID,

unsigned char dataOut[],

long *len,

LVBoolean *success);

Input

diagRef

Specifies the diagnostic session handle, obtained from

ndOpenDiagnostic

and passed

to subsequent diagnostic functions. Normally, it is not necessary to manually manipulate
the elements of this struct.

localID

Defines the local identifier of the data to be read. The values are application specific.

Output

dataOut

Returns the data record from the ECU. If you know the record data description, you can
use the

ndConvertToPhys

function to interpret it.

len

On input,

len

must contain the

dataOut

array length. On return, it contains the number

of valid data bytes in the

dataOut

array.

success

Indicates successful receipt of a positive response message for this diagnostic service.

Return Value

The return value indicates the function call status as a signed 32-bit integer. Zero means the
function executed successfully. A negative value specifies an error, which means the function
did not perform the expected behavior. A positive value specifies a warning, which means the
function performed as expected, but a condition arose that may require attention.

Use the

ndStatusToString

function to obtain a descriptive string for the return value.

Advertising