plucky (3) mongoc_cursor_get_hint.3.gz

Provided by: libmongoc-doc_1.30.0-1_all bug

WARNING:
          Deprecated since version 1.28.0: Use mongoc_cursor_get_server_id() instead.


SYNOPSIS
          uint32_t
          mongoc_cursor_get_hint (const mongoc_cursor_t *cursor);


PARAMETERS
       • cursor: A mongoc_cursor_t.


DESCRIPTION
       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.


AUTHOR
       MongoDB, Inc


       2009-present, MongoDB, Inc.