1MONGOC_BULK_OPERATION_GET_HINT(3)  libmongoc MONGOC_BULK_OPERATION_GET_HINT(3)
2
3
4

NAME

6       mongoc_bulk_operation_get_hint - mongoc_bulk_operation_get_hint()
7

SYNOPSIS

9          uint32_t
10          mongoc_bulk_operation_get_hint (const mongoc_bulk_operation_t *bulk);
11

PARAMETERS

13       • bulk: A mongoc_bulk_operation_t.
14

DESCRIPTION

16       Retrieves the opaque id of the server used for the operation.
17
18       (The  function  name includes the old term "hint" for the sake of back‐
19       ward compatibility, but we now call this number a "server id".)
20
21       This number is zero until the driver actually uses  a  server  in  mon‐
22       goc_bulk_operation_execute. The server id is the same number as the re‐
23       turn value  of  a  successful  mongoc_bulk_operation_execute,  so  mon‐
24       goc_bulk_operation_get_hint is useful mainly in case mongoc_bulk_opera‐
25       tion_execute fails and returns zero.
26

AUTHOR

28       MongoDB, Inc
29

31       2017-present, MongoDB, Inc
32
33
34
35
361.20.0                           Nov 18, 2021MONGOC_BULK_OPERATION_GET_HINT(3)
Impressum