Scroll to navigation

TSMGMTSOURCEGET(3ts) Apache Traffic Server TSMGMTSOURCEGET(3ts)

NAME

TSMgmtSourceGet - TSMgmtSourceGet API function

SYNOPSIS

#include <ts/ts.h>



DESCRIPTION

Get the source of a value for a configuration variable. var_name is the name of the variable as a nul terminated string. The source value is stored in result. The function can return failure if var_name is not found.

TYPES

Source of the current value for a management (configuration) value.
Invalid value, no source available. This is primarily used as an initialization or error value and should be returned only when the API call fails.

The default value provided by the Traffic Server core.

The configuration variable was created by a plugin and the value is the default value provided by a plugin.

The value has been set in records.config. Note this value is returned even if the variable was explicitly set to the default value.

The value was retrieved from the process environment, overriding the default value.


RETURN VALUES

TS_SUCCESS if the var_name was found, TS_ERROR if not.

COPYRIGHT

2024, dev@trafficserver.apache.org

January 6, 2024 9.2