MONGOC_DATABASE_COMMAND_SIMPLE(3) | Library Functions Manual | MONGOC_DATABASE_COMMAND_SIMPLE(3) |
NAME¶
mongoc_database_command_simple() - This is a simplified interface to mongoc_database_command() that returns the first result document.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.
NOTE
This function will always initialize reply
bson_destroy(3) with reply as an argument.
ERRORS¶
Errors are propagated through the error parameter.RETURNS¶
true on success, false on failure and error is set.COLOPHON¶
This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.2016‐10‐12 | MongoDB C Driver |