.\" Man page generated from reStructuredText.
.
.TH "MONGOC_URI_NEW_WITH_ERROR" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_uri_new_with_error \- mongoc_uri_new_with_error()
.
.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
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongoc_uri_t *
mongoc_uri_new_with_error (const char *uri_string,
                           bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT;
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBuri_string\fP: A string containing a URI.
.IP \(bu 2
\fBerror\fP: An optional location for a \fBbson_error_t\fP or \fBNULL\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
Parses a string containing a MongoDB style URI connection string.
.SH RETURNS
.sp
A newly allocated \fBmongoc_uri_t\fP if successful. Otherwise \fBNULL\fP
populating \fBerror\fP with the error description.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
Failure to handle the result of this function is a programming error.
.UNINDENT
.UNINDENT
.SH EXAMPLES
.sp
Examples of some valid MongoDB connection strings can be seen below.
.sp
\fB"mongodb://localhost/"\fP
.sp
\fB"mongodb://localhost/?replicaSet=myreplset"\fP
.sp
\fB"mongodb://myuser:mypass@localhost/"\fP
.sp
\fB"mongodb://kerberosuser%40EXAMPLE.COM@example.com/?authMechanism=GSSAPI"\fP
.sp
\fB"mongodb://[::1]:27017/"\fP
.sp
\fB"mongodb://10.0.0.1:27017,10.0.0.1:27018,[::1]:27019/?tls=true"\fP
.sp
\fB"mongodb://%2Ftmp%2Fmongodb\-27017.sock"\fP
.sp
\fB"mongodb://user:pass@%2Ftmp%2Fmongodb\-27017.sock"\fP
.sp
\fB"mongodb://localhost,[::1]/mydb?authSource=mydb"\fP
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.