stringwrite_config_string

March 26, 2020 Contributors

Name

stringwrite_config_string — Output a string to the system console

Synopsis

#include "misc/ec_string.h"

| string * **stringwrite_config_string** ( | str, |   |
|   | label, |   |
|   | value, |   |
|   | xml); |   |

string * <var class="pdparam">str</var>;
const char * <var class="pdparam">label</var>;
const char * <var class="pdparam">value</var>;
int <var class="pdparam">xml</var>;

Description

Output a string to the system console.

Note

This function is deprecated in Momentum version 3.0. It is suitable only for supporting legacy modules doing ‘write config’.

Parameters

str

An ec_string.

label

A character array, typically an option name.

value

The value of label.

xml

Whether or not to render as XML. Set this value to 0 or 1.

Return Values

This function returns an ec_string terminated by a newline.

Threading

It is legal to call this function in any thread.