CAPLfunctionAfdxGetTokenInt64

AfdxGetTokenInt64

Valid for: CANoe DE • CANoe:lite DE • CANoe4SW DE • CANoe4SW:lite DE

Function Syntax

int64 AfdxGetTokenInt64( long packet, char protocolDesignator[], char tokenDesignator[] ); // form 1
int64 AfdxGetTokenInt64( long packet, char protocolDesignatorl[], char tokenDesignator[], long offset, long length, long networkByteOrder ); // form 2

Description

This function returns the specified token’s data as a 64-bit integer value. With additional parameters (form 2) the user may specify the starting byte, length and byte ordering of the extracted integer value.

Note: The network byte order interpretation for form 1 is big-endian.

Parameters

• packet: Handle of the message that has been created with AfdxInitPacket.
• protocolDesignator: Name of the protocol, e.g. “afdx”.
• tokenDesignator: Name of the token, e.g. “lpvSpeed”.
• offset: This is the offset from the beginning of the token’s data area. If this is 0, data is copied starting at byte 0 of the token’s data area.
• length: This is the length of the integer value to be returned from the token’s data (range 1..8).
• networkByteOrder:
  • 0: INTEL (little-endian)
  • 1: MOTOROLA (big-endian)

Return Values

Integer value gathered from the token’s data. With AfdxGetLastError you have to check if the function has been processed successfully.

Example

Node System - PreStart in CAPL Browser

on preStart
{
  AfdxRegisterReceiveCallback ( "OnAfdxPacket");
}

Node Callback Function in CAPL Browser

void OnAfdxPacket( long dir, long line, int64 timestamp, long bag, long afdxFlags, long packet )
{
  int64 timeTS;
  char error[100];

  // get a signed double length integer at FDS1 (offset = 8) with length 8:
  timeTS = AfdxGetTokenInt64(packet, "afdx", "data", 8, 8, 1 );
  if (AfdxGetLastError() == 0)
  {
    // do something with timeTS
  }
  else
  {
    AfdxGetLastErrorText( elCount(error), error );
    write("Error: %s", error );
  }
}