.\" Man page generated from reStructuredText.
.
.TH "TSMGMTSOURCEGET" "3ts" "Mar 08, 2019" "7.1" "Apache Traffic Server"
.SH NAME
TSMgmtSourceGet \- TSMgmtSourceGet API function
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fI#include <ts/ts.h>\fP
.INDENT 0.0
.TP
.B TSReturnCode TSMgmtSourceGet(const char *\fI\ var_name\fP, \fI\%TSMgmtSource\fP *\fI\ result\fP)
.UNINDENT
.SH DESCRIPTION
.sp
Get the source of a value for a configuration variable. \fIvar_name\fP is the name of the variable
as a nul terminated string. The source value is stored in \fIresult\fP\&. The function can return
failure if \fIvar_name\fP is not found.
.SH TYPES
.INDENT 0.0
.TP
.B TSMgmtSource
Source of the current value for a management (configuration) value.
.INDENT 7.0
.TP
.B TS_MGMT_SOURCE_NULL
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.
.UNINDENT
.INDENT 7.0
.TP
.B TS_MGMT_SOURCE_DEFAULT
The default value provided by the Traffic Server core.
.UNINDENT
.INDENT 7.0
.TP
.B TS_MGMT_SOURCE_PLUGIN
The configuration variable was created by a plugin and the value is the default value provided
by a plugin.
.UNINDENT
.INDENT 7.0
.TP
.B TS_MGMT_SOURCE_EXPLICIT
The value has been set in \fBrecords.config\fP\&. Note this value is returned even if the
variable was explicitly set to the default value.
.UNINDENT
.INDENT 7.0
.TP
.B TS_MGMT_SOURCE_ENV
The value was retrieved from the process environment, overriding the default value.
.UNINDENT
.UNINDENT
.SH RETURN VALUES
.sp
\fBTS_SUCCESS\fP if the \fIvar_name\fP was found, \fBTS_ERROR\fP if not.
.SH COPYRIGHT
2019, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.