ECU Measurement and Calibration Toolkit C API Reference

Content Type
Programming Language
Current manual

mcXCPGetId

mcXCPGetId

Purpose

Queries session configuration or slave device identification.

Format

mcTypeStatus mcXCPGetId(
mcTypeTaskRef ECURefNum,
u8 Type,
u32 *Length,
char *Id);

Input

ECURefNum

ECURefNum is the task reference which links to the selected ECU. This reference is originally returned from mcECUSelectEx.

Type

Type specifies the type of the requested identification:

TypeDescription
0ASCII text
1ASAM-MC2 filename without path and extension
2ASAM-MC2 filename with path and extension
3URL where the ASAM-MC2 file can be found
4ASAM-MC2 file to upload
128..255User defined

Output

Length

Length returns the string length of the Id string.

Id

Id contains the queried identification string.

Return Value

The return value indicates the status of the function call 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 mcStatusToString function of the ECU M&C API to obtain a descriptive string for the return value.

Description

mcXCPGetId implements the XCP command GET_ID and returns session configuration or slave device identification information of the selected ECU slave device. The supported types are implementation specific of the ECU slave device. The identification string is ASCII text format.

Was this information helpful?