bool
Contents
Copyright
2009-present, MongoDB, Inc.
1.30.4 Jun 08, 2025 MONGOC_COLLECTION_FIND_AND_MODIFY_WITH_OPTS(3)
Description
Update and return an object.
reply is always initialized, and must be freed with bson_destroy().
If an unacknowledged write concern is set (through mongoc_find_and_modify_opts_append()), the output
reply is always an empty document.
On success, the output reply contains the full server reply to the findAndModify command. See the MongoDBManualpageforfindAndModify for the expected server reply.
Errors
Errors are propagated via the error parameter.
Example
See the example code for mongoc_find_and_modify_opts_t.
Parameters
• collection: A mongoc_collection_t.
• query: A bson_t containing the query to locate target document(s).
• opts: A findandmodifyoptions. Must not be NULL.
• reply: A maybe-NULL pointer to overwritablestorage for a bson_t to contain the results.
• error: An optional location for a bson_error_t or NULL.
Returns
Returns true if successful. Returns false and sets error if there are invalid arguments or a server or
network error.
A write concern timeout or write concern error is considered a failure.
Synopsis
bool
mongoc_collection_find_and_modify_with_opts (
mongoc_collection_t *collection,
const bson_t *query,
const mongoc_find_and_modify_opts_t *opts,
bson_t *reply,
bson_error_t *error);
