.\" 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 "MONGOC_STREAM_WRITE" "3" "May 07, 2024" "1.27.1" "libmongoc"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
ssize_t
mongoc_stream_write (mongoc_stream_t *stream,
                     void *buf,
                     size_t count,
                     int32_t timeout_msec);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBstream\fP: A \fI\%mongoc_stream_t\fP\&.
.IP \(bu 2
\fBbuf\fP: The buffer to write.
.IP \(bu 2
\fBcount\fP: The number of bytes to write.
.IP \(bu 2
\fBtimeout_msec\fP: The number of milliseconds to wait before failure, a timeout of 0 will not block. If negative, use the default timeout.
.UNINDENT
.sp
The \fI\%mongoc_stream_write()\fP function shall perform a write to a \fI\%mongoc_stream_t\fP\&. It\(aqs modeled on the API and semantics of \fBwrite()\fP, though the parameters map only loosely.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The \(dqdefault timeout\(dq indicated by a negative value is both unspecified and
unrelated to the documented default values for \fB*TimeoutMS\fP URI options.
To specify a default timeout value for a \fB*TimeoutMS\fP URI option, use the
\fBMONGOC_DEFAULT_*\fP constants defined in \fBmongoc\-client.h\fP\&.
.UNINDENT
.UNINDENT
.SH RETURNS
.sp
The \fI\%mongoc_stream_write()\fP function returns the number of bytes written on success. It returns \fB\-1\fP and sets \fBerrno\fP upon failure.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
.nf
\fI\%mongoc_stream_read()\fP
.fi
.sp
.nf
\fI\%mongoc_stream_readv()\fP
.fi
.sp
.nf
\fI\%mongoc_stream_writev()\fP
.fi
.sp
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.