Skip to main content
Open topic with navigation CAPL Function Overview » MOST » mostParamGetStringAscii

​
mostParamGetStringAscii

Valid for: CANoe DE

​
Function Syntax

long mostParamGetStringAscii(mostAmsMessage msg, char paramAdr[], char buffer[], long buffersize); // form 1
long mostParamGetStringAscii(mostAmsMessage msg, char paramAdr[], long arrayIndex, char buffer[], long buffersize); // form 2

​
Description

Query of parameters of the String type from an AMS message and decode to ASCII format using the parameter name from the XML function catalog. Unsupported characters are ignored. Note: The message data must contain a parameter with the given parameter address. Since the compiler is not able to validate this, errors are detected at runtime of the CAPL program only. If the parameter is not part of the message or not the expected type, an error text is displayed in the Write Window and the measurement stops. The function mostParamIsAvailable can be applied to assure parameter availability.

​
Parameters

  • msg: Message in which the parameter value should be described.
  • paramAdr: Identification of parameters (see Symbolic Identification of Parameters).
  • arrayIndex: Parameter index in arrays or sequences. This declaration overwrites the indexing in the brackets of <paramAdr>.
  • buffer: Buffer to which the ASCII string parameter is copied.
  • bufferSize: Maximum number of copied ASCII string parameter bytes (can be specified with (elcount(buffer))).

​
Return Values

  • >= 0: number of converted characters
  • \< 0: See error codes

​
Example

on mostAmsMessage AmFmTuner.RadioText.Status
{
  char buffer[200];
  long dataLen;
  // get string parameter data
  datalen = mostParamGetStringAscii(this, "TextA", buffer, elcount(buffer));
  if(datalen >= 0)
  {
    write("Radiotext: %s", buffer);
  }
}
Input: Message parameter bytes: 00 00 61 00 62 00 63 00 00
Output: Radiotext: abc