mongoc_database_command_simple man page

mongoc_database_command_simple() — This is a simplified interface to mongoc_database_command() that returns the first result document. The database's read preference, read concern, and write concern are not applied to the command. The parameter reply is initialized even upon failure to simplify memory management.

Synopsis

bool
mongoc_database_command_simple (mongoc_database_t         *database,
                                const bson_t              *command,
                                const mongoc_read_prefs_t *read_prefs,
                                bson_t                    *reply,
                                bson_error_t              *error);

Parameters

database
A mongoc_database_t
command
A bson_t containing the command.
read_prefs
An optional mongoc_read_prefs_t MONGOC_READ_PRIMARY
reply
A location to store the commands first result document.
error
An optional location for a bson_error_t or NULL

This is a simplified interface to mongoc_database_command(3) that returns the first result document. The database's read preference, read concern, and write concern are not applied to the command. The parameter reply is initialized even upon failure to simplify memory management.

Errors

Errors are propagated through the error parameter.

Returns

true on success, false on failure 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