mongoc_matcher_new man page

mongoc_matcher_new() — None

Synopsis

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

Create a new mongoc_matcher_t using the query specification provided.

Deprecated

NOTE

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(3) when no longer in use. Upon failure, NULL is returned and error is set. This could happen if query contains an invalid query specification.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Referenced By

mongoc_matcher_match(3).

2016‐10‐20 MongoDB C Driver