File: mongoc_gridfs_file_get_id.rst

package info (click to toggle)
mongo-c-driver 1.17.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 37,256 kB
  • sloc: ansic: 152,613; javascript: 7,954; python: 3,259; sh: 138; makefile: 29; xml: 10
file content (30 lines) | stat: -rw-r--r-- 577 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
:man_page: mongoc_gridfs_file_get_id

mongoc_gridfs_file_get_id()
===========================

Synopsis
--------

.. code-block:: c

  const bson_value_t *
  mongoc_gridfs_file_get_id (mongoc_gridfs_file_t *file);

Parameters
----------

* ``file``: A :symbol:`mongoc_gridfs_file_t`.

Description
-----------

Fetches the id of a gridfs file.

The C Driver always uses an ObjectId for ``_id``, but files created by other drivers may have any type of ``_id``.

Returns
-------

Returns a :symbol:`const bson_value_t * <bson:bson_value_t>` that should not be modified or freed.