Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_BULK_OPERATION_GET_HINT(3)  libmongoc MONGOC_BULK_OPERATION_GET_HINT(3)

WARNING:
	  Deprecated	     since	   version	   1.28.0:	   Use
	  mongoc_bulk_operation_get_server_id()	instead.

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	 back-
       ward 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

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025MONGOC_BULK_OPERATION_GET_HINT(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_bulk_operation_get_hint&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help