.\" Man page generated from reStructuredText.
.
.TH "MONGOC_CURSOR_GET_HINT" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_cursor_get_hint \- mongoc_cursor_get_hint()
.
.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
uint32_t
mongoc_cursor_get_hint (const mongoc_cursor_t *cursor);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBcursor\fP: A \fBmongoc_cursor_t\fP\&.
.UNINDENT
.SH DESCRIPTION
.sp
Retrieves the opaque id of the server used for the operation.
.sp
(The function name includes the old term "hint" for the sake of backward compatibility, but we now call this number a "server id".)
.sp
This number is zero until the driver actually uses a server when executing the find operation or \fBmongoc_cursor_set_hint\fP is called.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.