Skip to main content
Open topic with navigation CAPL Functions » MOST » mostParamSetData

​
mostParamSetData

Valid for: CANoe DE

​
Function Syntax

long mostParamSetData(mostAmsMessage msg, char paramadr[], byte data[], long datalen); // form 1
long mostParamSetData(mostAmsMessage msg, char paramadr[], long arrayIndex, byte data[], long datalen); // form 2

​
Description

Setting of parameters of the String type or RawStream in an AMS message using the parameter name from the XML function catalog. When writing a string parameter with mostParamSetData ‘data’ has to include the coding byte and terminator character (mostParamSetString can be used for ASCII coding). 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. When using function mostParamSetData to build a message dump, the parameters must be populated in the order specified by the MOST Function Catalog, particularly for messages with StreamCases.

​
Parameters

  • msg: Message in which the parameter bytes should be written.
  • 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>.
  • data: Data from which the parameter bytes are copied.
  • datalen: Number of valid parameter bytes that are copied to the message.

​
Return Values

See error codes.

​
Example

— mostParamIsAvailable • mostParamGet • mostParamGetData • mostParamGetString • mostParamSet • mostParamSetString • General Tips on XML Function Catalog Support in CAPL • Symbolic Identification of Parameters