.\" Man page generated from reStructuredText.
.
.TH "TSURLHOSTSET" "3ts" "Aug 29, 2018" "7.0" "Apache Traffic Server"
.SH NAME
TSUrlHostSet \- traffic Server URL component manipulation API
.
.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 TSUrlHostSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlSchemeSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlUserSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlPasswordSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlPortSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, int\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlPathSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlHttpQuerySet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlHttpParamsSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSUrlHttpFragmentSet(TSMBuffer\fI\ bufp\fP, TSMLoc\fI\ offset\fP, const char *\fI\ value\fP, int\fI\ length\fP)
.UNINDENT
.SH DESCRIPTION
.sp
The URL data structure is a parsed version of a standard internet URL. The
Traffic Server URL API provides access to URL data stored in marshal
buffers. The URL functions can create, copy, retrieve or delete entire URLs,
and retrieve or modify parts of URLs, such as their host, port or scheme
information.
.sp
\fI\%TSUrlSchemeSet()\fP, \fI\%TSUrlUserSet()\fP, \fI\%TSUrlPasswordSet()\fP,
\fI\%TSUrlHostSet()\fP, \fI\%TSUrlHttpParamsSet()\fP, \fI\%TSUrlHttpQuerySet()\fP
and \fI\%TSUrlHttpFragmentSet()\fP each set the specified portion of the URL
located at offset within the marshal buffer \fIbufp\fP to the string
value. If \fIlength\fP is \fB\-1\fP then these functions assume that value
is NULL\-terminated. Otherwise, the length of the \fIstring\fP value is taken
to be the value of \fIlength\fP\&. These functions copy the string to within
\fIbufp\fP, so it can be subsequently modified or deleted.
.sp
\fI\%TSUrlPortSet()\fP sets the port number portion of the URL located at
\fIoffset\fP within the marshal buffer \fIbufp\fP to the value
port. Normal canonicalization based on the URL scheme still applies.
.SH RETURN VALUES
.sp
All these APIs returns a \fBTSReturnCode\fP, indicating success
(\fBTS_SUCCESS\fP) or failure (\fBTS_ERROR\fP) of the operation.
.SH SEE ALSO
.sp
\fBTSAPI(3ts)\fP,
\fBTSUrlCreate(3ts)\fP,
\fBTSUrlHostGet(3ts)\fP,
\fBTSUrlStringGet(3ts)\fP,
\fBTSUrlPercentEncode(3ts)\fP
.SH COPYRIGHT
2018, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.