Deprecated since version 1.28.0: Use mongoc_cursor_set_server_id() instead.
Contents
Copyright
2009-present, MongoDB, Inc.
1.30.4 Jun 08, 2025 MONGOC_CURSOR_SET_HINT(3)
Description
Specifies which server to use for the operation. This function has an effect only if called before the
find operation is executed.
(The function name includes the old term "hint" for the sake of backward compatibility, but we now call
this number a "server id".)
Use mongoc_cursor_set_hint only for building a language driver that wraps the C Driver. When writing
applications in C, leave the server id unset and allow the driver to choose a suitable server from the
find operation's read preference.
Parameters
• cursor: A mongoc_cursor_t.
• server_id: An opaque id identifying the server to use.
Returns
Returns true on success. If any arguments are invalid, returns false and logs an error.
Synopsis
bool
mongoc_cursor_set_hint (mongoc_cursor_t *cursor, uint32_t server_id);
Warning:
Deprecated since version 1.28.0: Use mongoc_cursor_set_server_id() instead.
