mongoc_collection_copy(3)

mongoc_collection_copy()

Section 3 libmongoc-doc bookworm source

Description

MONGOC_COLLECTION_COPY

NAME

mongoc_collection_copy - mongoc_collection_copy()

SYNOPSIS

mongoc_collection_t *
mongoc_collection_copy (mongoc_collection_t *collection)
BSON_GNUC_WARN_UNUSED_RESULT;

PARAMETERS

collection: A mongoc_collection_t.

DESCRIPTION

Performs a deep copy of the collection struct and its configuration. Useful if you intend to call mongoc_collection_set_write_concern(), mongoc_collection_set_read_prefs(), or mongoc_collection_set_read_concern(), and want to preserve an unaltered copy of the struct.

This function does not copy the contents of the collection on the MongoDB server.

RETURNS

A newly allocated mongoc_collection_t that should be freed with mongoc_collection_destroy() when no longer in use.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc