mongoc_collection_find_and_modify_with_opts(3)

MONGOC_COLLECTION_FIND_AND_MODIFY_WITH_OPTS(3)

MongoDB C Driver

MONGOC_COLLECTION_FIND_AND_MODIFY_WITH_OPTS(3)

NAME

mongoc_collection_find_and_modify_with_opts - mongoc_collection_find_and_modify_with_opts()

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);

PARAMETERS

collection: A mongoc_collection_t.
query: A bson_t containing the query to locate target document(s).
opts: A find and modify options. Must not be NULL.
reply: An optional location for a bson_t that will be initialized with the result or NULL.
error: An optional location for a bson_error_t or NULL.

DESCRIPTION

Update and return an object.

reply is always initialized, and must be freed with bson_destroy().

ERRORS

Errors are propagated via the error parameter.

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.

EXAMPLE

See the example code for mongoc_find_and_modify_opts_t.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

June 1, 2021

1.14.0