.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "MONGOC_BULK_OPERATION_GET_HINT" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_bulk_operation_get_hint() \- Retrieves the opaque id of the server used for the operation.
.SH "SYNOPSIS"

.nf
.nf
uint32_t
mongoc_bulk_operation_get_hint (const mongoc_bulk_operation_t *bulk);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
bulk
A
.B mongoc_bulk_operation_t
.
.LP

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


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