1BSON_APPEND_DBPOINTER(3)            libbson           BSON_APPEND_DBPOINTER(3)
2
3
4

NAME

6       bson_append_dbpointer - bson_append_dbpointer()
7

SYNOPSIS

9          #define BSON_APPEND_DBPOINTER(b, key, coll, oid) \
10             bson_append_dbpointer (b, key, (int) strlen (key), coll, oid)
11
12          bool
13          bson_append_dbpointer (bson_t *bson,
14                                 const char *key,
15                                 int key_length,
16                                 const char *collection,
17                                 const bson_oid_t *oid);
18

PARAMETERS

20       • bson: A bson_t.
21
22       • key: An ASCII C string containing the name of the field.
23
24       • key_length: The length of key in bytes, or -1 to determine the length
25         with strlen().
26
27       • collection: The target collection name.
28
29       • oid: The target document identifier.
30

DESCRIPTION

32       WARNING:
33          The dbpointer field type is DEPRECATED and should only be used  when
34          interacting with legacy systems.
35

RETURNS

37       Returns  true  if  the operation was applied successfully. The function
38       will fail if appending the array grows bson larger than INT32_MAX.
39

AUTHOR

41       MongoDB, Inc
42

44       2017-present, MongoDB, Inc
45
46
47
48
491.24.3                           Aug 17, 2023         BSON_APPEND_DBPOINTER(3)
Impressum