bionic (3) mongoc_collection_drop_with_opts.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME
       mongoc_collection_drop_with_opts - mongoc_collection_drop_with_opts()


SYNOPSIS
          bool
          mongoc_collection_drop_with_opts (mongoc_collection_t *collection,
                                            bson_t *opts,
                                            bson_error_t *error);


PARAMETERS
       • collection: A mongoc_collection_t.

       • opts: A bson_t or NULL.

       • error: An optional location for a bson_error_t or NULL.


DESCRIPTION
       This  function  requests  that  a  collection  be  dropped,  including  all  indexes  associated with the
       collection.

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


ERRORS
       Errors are propagated via the error parameter.


RETURNS
       Returns true if the collection was successfully dropped. Returns  false  and  sets  error  if  there  are
       invalid arguments or a server or network error.


AUTHOR
       MongoDB, Inc


       2018, MongoDB, Inc