mongoc_cursor_get_hint man page

mongoc_cursor_get_hint() — Retrieves the opaque id of the server used for the operation.

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_hint is called.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐20 MongoDB C Driver