mongoc_bulk_operation_get_hint man page

mongoc_bulk_operation_get_hint — mongoc_bulk_operation_get_hint()

Synopsis

uint32_t
mongoc_bulk_operation_get_hint (const mongoc_bulk_operation_t *bulk);

Parameters

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 in mongoc_bulk_operation_execute. The server id is the same number as the return value of a successful mongoc_bulk_operation_execute, so mongoc_bulk_operation_get_hint is useful mainly in case mongoc_bulk_operation_execute fails and returns zero.

Author

MongoDB, Inc

Info

Sep 15, 2017 1.8.0 MongoDB C Driver