mongoc_bulk_operation_remove_one_with_opts()

Synopsis

bool
mongoc_bulk_operation_remove_one_with_opts (mongoc_bulk_operation_t       *bulk,
                                            const bson_t                  *selector,
                                            const bson_t                  *opts,
                                            bson_error_t                  *error); /* OUT */

Remove a single document as part of a bulk operation. This only queues the operation. To execute it, call mongoc_bulk_operation_execute().

Parameters

bulk

A mongoc_bulk_operation_t.

selector

A bson_t that selects which documen to remove.

opts

A bson_t containing additional options.

error

An optional location for a bson_error_t or NULL.

Errors

Operation errors are propagated via mongoc_bulk_operation_execute(), while argument validation errors are reported by the error argument.

Returns

Returns true on success, and false otherwise.