mongoc_client_command_simple man page

mongoc_client_command_simple() — None

Synopsis

bool
mongoc_client_command_simple (mongoc_client_t           *client,
                              const char                *db_name,
                              const bson_t              *command,
                              const mongoc_read_prefs_t *read_prefs,
                              bson_t                    *reply,
                              bson_error_t              *error);

This is a simplified interface to mongoc_client_command(3) reply

NOTE

reply is always set, and should be released with bson_destroy(3)

Parameters

client
A mongoc_client_t
db_name
The name of the database to run the command on.
command
A bson_t containing the command specification.
read_prefs
An optional mongoc_read_prefs_t MONGOC_READ_PRIMARY
reply
A location for the resulting document.
error
An optional location for a bson_error_t or NULL

Errors

Errors are propagated via the error parameter.

Returns

true if successful; otherwise false and error is set.

This function does not check the server response for a write concern error or write concern timeout.

Colophon

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

Info

2016‐11‐07 MongoDB C Driver