.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "TRAFFIC SERVER RECORDS" "3ts" "Jan 06, 2024" "9.2" "Apache Traffic Server"
.SH NAME
Traffic Server Records \- traffic Server maintains a set of records which cover both configuration values and statistics
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <ts/ts.h>
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%TSReturnCode\fP TSMgmtStringCreate(\fI\%TSRecordType\fP rec_type, const char *name, const \fI\%TSMgmtString\fP data_default, \fI\%TSRecordUpdateType\fP update_type, \fI\%TSRecordCheckType\fP check_type, const char *check_regex, \fI\%TSRecordAccessType\fP access_type) 
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%TSReturnCode\fP TSMgmtIntCreate(\fI\%TSRecordType\fP rec_type, const char *name, const \fI\%TSMgmtInt\fP data_default, \fI\%TSRecordUpdateType\fP update_type, \fI\%TSRecordCheckType\fP check_type, const char *check_regex, \fI\%TSRecordAccessType\fP access_type) 
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%TSMgmtStringCreate()\fP registers \fIname\fP as a configuration name and sets its various properties. If \fIcheck_type\fP is \fI\%TS_RECORDCHECK_STR\fP then \fIcheck_reg\fP must be point to a valid regular expression to use to check the string value.
.sp
If a plugin uses a value from \fI\%records.config\fP that is not built in to Traffic Server it must use this function or the value will be inaccessible and a warning for that name will be generated.
.SH RETURN VALUES
.sp
\fI\%TSMgmtStringCreate()\fP and \fI\%TSMgmtIntCreate()\fP return \fBTS_SUCCESS\fP if the management value was created and \fBTS_ERROR\fP if not.
.SH SEE ALSO
.sp
\fBTSAPI(3ts)\fP
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.