mongoc_cursor_get_hint(3)

mongoc_cursor_get_hint3

Usage

uint32_t
mongoc_cursor_get_hint (const mongoc_cursor_t *cursor);

WARNING:

Deprecated since version 1.28.0: Use mongoc_cursor_get_server_id() instead.

Parameters

•

cursor: A mongoc_cursor_t.

Overview

Retrieves the opaque id of the server used for the operation.

(The function name includes the old term "hint" for the sake of backward compatibility, but we now call this number a "server id".)

This number is zero until the driver actually uses a server when executing the find operation or mongoc_cursor_set_server_id() is called.

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

Author

MongoDB, Inc

From libmongoc-doc 1.30.4-1+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.