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

NAME

6       mongoc_gridfs_find_one - mongoc_gridfs_find_one()
7
8       WARNING:
9          Deprecated  since  version  1.5.0:  This function is deprecated, use
10          mongoc_gridfs_find_one_with_opts() instead.
11
12

SYNOPSIS

14          mongoc_gridfs_file_t *
15          mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs,
16                                  const bson_t *query,
17                                  bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT
18             BSON_GNUC_DEPRECATED_FOR (mongoc_gridfs_find_one_with_opts);
19

PARAMETERS

21       • gridfs: A mongoc_gridfs_t.
22
23       • query: A bson_t.
24
25       • error: An optional location for a bson_error_t or NULL.
26

DESCRIPTION

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

ERRORS

40       Errors are propagated via the error parameter.
41

RETURNS

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

AUTHOR

48       MongoDB, Inc
49

51       2017-present, MongoDB, Inc
52
53
54
55
561.24.3                           Aug 17, 2023        MONGOC_GRIDFS_FIND_ONE(3)
Impressum