1MONGOC_GRIDFS_FIND_ONE(3)          libmongoc         MONGOC_GRIDFS_FIND_ONE(3)
2
3
4

WARNING:

6          Deprecated  since  version  1.5.0:  This function is deprecated, use
7          mongoc_gridfs_find_one_with_opts() instead.
8
9

SYNOPSIS

11          mongoc_gridfs_file_t *
12          mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs,
13                                  const bson_t *query,
14                                  bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT
15             BSON_GNUC_DEPRECATED_FOR (mongoc_gridfs_find_one_with_opts);
16

PARAMETERS

18       • gridfs: A mongoc_gridfs_t.
19
20       • query: A bson_t.
21
22       • error: An optional location for a bson_error_t or NULL.
23

DESCRIPTION

25       This function shall execute a query on the underlying gridfs  implemen‐
26       tation.  The first file matching query will be returned. If there is an
27       error, NULL is returned and error is filled out; if there is  no  error
28       but  no matching file is found, NULL is returned and the error code and
29       domain are 0.
30
31       This function is considered a retryable read operation.  Upon  a  tran‐
32       sient error (a network error, errors due to replica set failover, etc.)
33       the operation is safely retried once.  If retryreads is  false  in  the
34       URI (see mongoc_uri_t) the retry behavior does not apply.
35

ERRORS

37       Errors are propagated via the error parameter.
38

RETURNS

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

AUTHOR

45       MongoDB, Inc
46

48       2017-present, MongoDB, Inc
49
50
51
52
531.25.1                           Nov 08, 2023        MONGOC_GRIDFS_FIND_ONE(3)
Impressum