mongoc_bulk_operation_get_hint man page

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

Synopsis

uint32_t
mongoc_bulk_operation_get_hint (const mongoc_bulk_operation_t *bulk);

Parameters

bulk
A mongoc_bulk_operation_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 in mongoc_bulk_operation_execute mongoc_bulk_operation_execute , so mongoc_bulk_operation_get_hint is useful mainly in case mongoc_bulk_operation_execute fails and returns zero.

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