mongoc_collection_drop_index_with_opts man page

mongoc_collection_drop_index_with_opts — mongoc_collection_drop_index_with_opts()

Synopsis

bool
mongoc_collection_drop_index_with_opts (mongoc_collection_t *collection,
                                        const char *index_name,
                                        const bson_t *opts,
                                        bson_error_t *error);

Parameters

·

collection: A mongoc_collection_t.

·

index_name: A string containing the name of the index.

·

opts: A bson:bson_t or NULL.

·

error: An optional location for a bson_error_t or NULL.

Description

This function requests than an index on collection be dropped. In the event of an error it returns false and error is set.

If no write concern is provided in opts, the collection's write concern is used.

Errors

Errors are propagated via the error parameter.

Returns

true if successful, otherwise false and error is set.

Author

MongoDB, Inc

Info

Feb 02, 2017 1.6.0 MongoDB C Driver