.\" 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_CHANGE_STREAM_GET_RESUME_TOKEN" "3" "May 07, 2024" "1.27.1" "libmongoc"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
const bson_t *
mongoc_change_stream_get_resume_token (mongoc_change_stream_t *stream);
.EE
.UNINDENT
.UNINDENT
.sp
This function returns the cached resume token, which may be passed as either the
\fBresumeAfter\fP or \fBstartAfter\fP option of a \fBwatch\fP function to start a new
change stream from the same point.
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBstream\fP: A \fI\%mongoc_change_stream_t\fP\&.
.UNINDENT
.SH RETURNS
.sp
A \fI\%bson_t\fP that should not be modified or freed.
.sp
Returns \fBNULL\fP if no resume token is available. This is possible if the change
stream has not been iterated and neither \fBresumeAfter\fP nor \fBstartAfter\fP
options were specified in the \fBwatch\fP function.
.SH LIFECYCLE
.sp
The returned \fI\%bson_t\fP is valid for the lifetime of \fBstream\fP and
its data may be updated if \fI\%mongoc_change_stream_next()\fP is called after
this function. The value may be copied to extend its lifetime or preserve the
current resume token.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.