ECU Measurement and Calibration Toolkit C API Reference

Content Type
Programming Language
Current manual
Table of Contents

MC Get Names.vi

MC Get Names.vi

Purpose

Gets an array of ECU names, Measurement names, Characteristic names, Event names, Calibration page names, or Group names from a specified A2L database file.

Format

diagram

Input

long unsigned integer Type (mode) is an input that specifies the type of names to return.

The value of Type (mode) is an enumeration:

0ECU Names returns a list of ECU names. You can write this list to MC ECU Select.vi. This is the default value.

1Measurement Names returns a list of Measurement names.

2Characteristic Names returns a list of Characteristic names.

3Event Channel Names returns a list of Event Channel names.

4Defined Pages Names returns a list of Calibration page names.

5Group Names returns a list of Group names.

6Group–Subgroup Names returns a list of Subgroup names of the specified Group name.

7Group–Measurement Names returns a list of Measurement names within the specified Group.

8Group–Characteristic Names returns a list of Characteristic names within the specified Group.

9Function Names returns a list of Function names within the specified ECU.

10Function–DefCharacteristic Names returns a list of Characteristic names referred by the DEF_CHARACTERISTIC keyword within the related Function.

11Function–RefCharacteristic Names returns a list of Characteristic names referred by the REF_CHARACTERISTIC keyword within the related Function.

12Function–InMeasurement Names returns a list of Measurement names referred by the IN_MEASUREMENT keyword within the related Function.

13Function–OutMeasurement Names returns a list of Measurement names referred by the OUT_MEASUREMENT keyword within the related Function.

14Function–LocMeasurement Names returns a list of Measurement names referred by the LOC_MEASUREMENT keyword within the related Function.

15Function–SubFunction Names returns a list of Function names referred by the SUB_FUNCTION keyword within the related Function.

16Group–Function List Names returns a list of Function names referred by the FUNCTION_LIST keyword within the related Group.

17XCP on CAN–Transport Layer Instance Names returns a list of Transport Layer Instance names of the XCP_ON_CAN blocks within the IF_DATA XCPplus block. No entries are returned for XCP_ON_CAN blocks without the TRANSPORT_LAYER_INSTANCE keyword or an XCP_ON_CAN block within an IF_DATA XCP block.

18XCP on TCP–Transport Layer Instance Names returns a list of Transport Layer Instance names of the XCP_ON_TCP_IP blocks within the IF_DATA XCPplus block. No entries are returned for XCP_ON_TCP_IP blocks without the TRANSPORT_LAYER_INSTANCE keyword or an XCP_ON_TCP_IP block within an IF_DATA XCP block.

19XCP on UDP–Transport Layer Instance Names returns a list of Transport Layer Instance names of the XCP_ON_UDP_IP blocks within the IF_DATA XCPplus block. No entries are returned for XCP_ON_UDP_IP blocks without the TRANSPORT_LAYER_INSTANCE keyword or an XCP_ON_UDP_IP block within an IF_DATA XCP block.

long unsigned integer Reference in must be an ECU M&C task reference or an A2L database reference.
string ECU name If a valid A2L database reference is passed to the reference in terminal, the ECU name terminal is used to select one of the ECUs inside the A2L database. Then, MC Get Names.vi will report the names of all objects of the specified type inside the ECU, based on the name provided. If you do not provide a name, the first ECU in the A2L file is selected.
cluster Error in is a cluster which describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster to error out.
boolean status is TRUE if an error occurred. This VI is not executed when status is TRUE.
long unsigned integer code is the error code number identifying an error. A value of 0 means success. A negative value means error: VI did not execute the intended operation. A positive value means warning: VI executed intended operation, but an informational warning is returned. For a description of the code, wire the error cluster to a LabVIEW error-handling VI, such as the Simple Error Handler.
string source identifies the VI where the error occurred.

Output

long unsigned integer Reference out is a copy of the reference which was passed to the reference in terminal.
long unsigned integer Names list out returns the array of names, one string entry per name. To start a Measurement task for all measurement names returned from MC Get Names.vi, wire the name list to MC DAQ Initialize.vi.
cluster Error out describes error conditions. If the Error in cluster indicated an error, the Error out cluster contains the same information. Otherwise, Error out describes the error status of this VI.
boolean status is TRUE if an error occurred.
long signed integer code is the error code number identifying an error. A value of 0 means success. A negative value means error: VI did not execute the intended operation. A positive value means warning: VI executed intended operation, but an informational warning is returned. For a description of the code, wire the error cluster to a LabVIEW error-handling VI, such as the Simple Error Handler.
string source identifies the VI where the error occurred.

Description

MC Get Names.vi is used to query the names contained within an A2L file.

The ECU name terminal is ignored if a valid ECU reference is connected to the reference in terminal. In that instance, MC Get Names.vi will report the names of all objects of the specified type inside the referenced ECU.

If type = 1, type = 2, or type = 3, the corresponding ECU name must be referenced in order to access ECU-specific properties.

If type = 6, type = 7, or type = 8, the corresponding Group name must be referenced in order to access the group properties.

If using MC Get Names.vi to query the list of supported event channels on an ECU, the event channels might be stored inside the ECU instead of the A2L file. To query these event channel names from the ECU directly, connect to the ECU using MC ECU Connect.vi before using MC Get Names.vi.

If using MC Get Names.vi to query the Group names and related hierarchy to build, for example, a tree user control to query these event channels, use MC Get Property.vi with the Group–Is Root? parameter.

NoteNote  For more details on how to query the Group information out of an A2L file, refer to the installed advanced example (Read A2L Group.vi) in the Example Finder.
Was this information helpful?