General functions, Ndclosediagnostic, General functions -12 – National Instruments CAN 372139B-01 User Manual

Page 176: Ndclosediagnostic -12

Advertising
background image

Chapter 6

Automotive Diagnostic Command Set API for C

Automotive Diagnostic Command Set User Manual

6-12

ni.com

General Functions

ndCloseDiagnostic

Purpose

Closes a diagnostic session.

Format

long ndCloseDiagnostic(

TD1 *diagRefIn);

Input

diagRefIn

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.

Output

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.

Description

The diagnostic session

diagRefIn

specifies is closed, and you can no longer use it for

communication to an ECU. This command does not communicate the closing to the ECU
before terminating; if this is necessary, you must manually do so (for example, by calling

ndStopDiagnosticSession

) before calling

ndCloseDiagnostic

.

Advertising