mongoc_matcher_new(3)

mongoc_matcher_new()

Section 3 libmongoc-doc bookworm source

Description

MONGOC_MATCHER_NEW

NAME

mongoc_matcher_new - mongoc_matcher_new()

SYNOPSIS

mongoc_matcher_t *
mongoc_matcher_new (const bson_t *query, bson_error_t *error)
BSON_GNUC_WARN_UNUSED_RESULT BSON_GNUC_DEPRECATED;

Create a new mongoc_matcher_t using the query specification provided.

DEPRECATED

WARNING:

mongoc_matcher_t is deprecated and will be removed in version 2.0.

PARAMETERS

query: A bson_t.

error: An optional location for a bson_error_t or NULL.

ERRORS

Errors are propagated via the error parameter.

RETURNS

A newly allocated mongoc_matcher_t that should be freed with mongoc_matcher_destroy() when no longer in use. Upon failure, NULL is returned and error is set. This could happen if query contains an invalid query specification.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc