mongoc_gridfs_find_one man page

mongoc_gridfs_find_one — mongoc_gridfs_find_one()

Deprecated

This function is deprecated, use mongoc_gridfs_find_one_with_opts instead.

Synopsis

mongoc_gridfs_file_t *
mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs,
                        const bson_t *query,
                        bson_error_t *error)
   BSON_GNUC_DEPRECATED_FOR (mongoc_gridfs_find_one_with_opts);

Parameters

·

gridfs: A mongoc_gridfs_t.

·

query: A bson:bson_t.

·

error: An optional location for a bson_error_t or NULL.

Description

This function shall execute a query on the underlying gridfs implementation. The first file matching query will be returned.

Errors

Errors are propagated via the error parameter.

Returns

A newly allocated mongoc_gridfs_file_t or NULL if no file could be found. You must free the resulting file with mongoc_gridfs_file_destroy() if non-NULL.

Author

MongoDB, Inc

Info

Feb 02, 2017 1.6.0 MongoDB C Driver