Skip to main content
Open topic with navigation CAPL Functions » ISO11783 » Virtual Terminal Interaction Layer (VT IL) » VTIL_GetDeviceName

​
VTIL_GetDeviceName

Valid for: CANoe DE • CANoe4SW DE

​
Function Syntax

  • long VTIL_GetDeviceName(qword& deviceName); // form 1
  • long VTIL_GetDeviceName(byte[] deviceName); // form 2
  • long VTIL_GetDeviceName(dbNode node, qword& deviceName); // form 3
  • long VTIL_GetDeviceName(dbNode node, byte[] deviceName); // form 4

​
Description

Function returns the current J1939 NAME of the simulation node (as set in the database and possibly changed by VTIL_SetNodeProperty).

​
Parameters

  • deviceName (Forms 1 and 3): Retrieved J1939 NAME as a qword.
  • deviceName (Forms 2 and 4): Retrieved J1939 NAME as a byte array with at least 8 bytes length.
  • node: Simulation node to apply the function.

​
Return Values

  • 0: Success, node is offline.
  • 1: Success, node is online.
  • -1: No device name available.
  • -2: Byte array is less than 8 bytes.

​
Example

on key '1'
{
  qword deviceName;
  // Get the J1939 NAME (as a qword) of the current simulation node
  VTIL_GetDeviceName(deviceName);
  write("DeviceName: 0x%Xll", deviceName);
}