.\" 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 "TSIPSTRINGTOADDR" "3ts" "Jan 06, 2024" "9.2" "Apache Traffic Server"
.SH NAME
TSIpStringToAddr \- TSIpStringToAddr API function
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <ts/experimental.h>
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%TSReturnCode\fP TSIpStringToAddr(const char *str, int str_len, sockaddr *addr) 
.UNINDENT
.SH DESCRIPTION
.sp
\fIstr\fP is expected to be an explicit address, not a hostname.  No hostname resolution is done. This attempts to
recognize and process a port value if present. It is set appropriately, or to zero if no port was found or it was
malformed.
.sp
It is intended to deal with the brackets that can optionally surround an IP address (usually IPv6) which in turn are
used to differentiate between an address and an attached port. E.g.
.INDENT 0.0
.INDENT 3.5
.sp
.EX

.EE
.UNINDENT
.UNINDENT
.sp
[FE80:9312::192:168:1:1]:80
.SH RETURN VALUES
.sp
It returns \fI\%TS_SUCCESS\fP on success, or \fI\%TS_ERROR\fP on failure.
.SH NOTES
.sp
This API may be changed in the future version since it is experimental.
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.