7.6.8 scx::scx_get_parameter

This function retrieves the value of a parameter from components present in EVSs or from plug-ins.

  • bool scx_get_parameter(const std::string &name, std::string &value);
  • template<class T>
    bool scx_get_parameter(const std::string &name, T &value);
  • bool scx_get_parameter(const std::string &name, int &value);
  • bool scx_get_parameter(const std::string &name, unsigned int &value);
  • bool scx_get_parameter(const std::string &name, long &value);
  • bool scx_get_parameter(const std::string &name, unsigned long &value);
  • bool scx_get_parameter(const std::string &name, long long &value);
  • bool scx_get_parameter(const std::string &name, unsigned long long &value);
  • std::string scx_get_parameter(const std::string &name);
name
the name of the parameter to retrieve. The parameter name must start with an EVS instance name for retrieving an EVS parameter or with a plug-in prefix (defaults to "TRACE") for retrieving a plug-in parameter.
value
a reference to the value of the parameter.

The bool forms of the function return true when the parameter exists, false otherwise. The std::string form returns the value of the parameter when it exists, empty string ("") otherwise.

Note:

Specify plug-ins before calling the platform parameter functions, so that the plug-ins load and their parameters are available. Any plug-in that is specified after the first call to any platform parameter function is ignored.
Non-ConfidentialPDF file icon PDF version100965_1180_00_en
Copyright © 2014–2019 Arm Limited or its affiliates. All rights reserved.