1MONGOC_CLIENT_SESSION_APPEND(3)    libmongoc   MONGOC_CLIENT_SESSION_APPEND(3)
2
3
4

NAME

6       mongoc_client_session_append - mongoc_client_session_append()
7

SYNOPSIS

9          bool
10          mongoc_client_session_append (const mongoc_client_session_t *client_session,
11                                        bson_t *opts,
12                                        bson_error_t *error);
13

PARAMETERS

15       • client_session: A pointer to a mongoc_client_session_t.
16
17       • opts: A pointer to a bson_t.
18
19       • error: An optional location for a bson_error_t or NULL.
20

DESCRIPTION

22       This  function  appends a logical session id to command options. Use it
23       to configure a session for any function that takes an options document,
24       such as mongoc_client_write_command_with_opts.
25
26       It is an error to use a session for unacknowledged writes.
27

RETURNS

29       Returns  true  on  success. If any arguments are invalid, returns false
30       and fills out error.
31

EXAMPLE

33       See the example code for mongoc_client_session_t.
34

AUTHOR

36       MongoDB, Inc
37

39       2017-present, MongoDB, Inc
40
41
42
43
441.20.0                           Nov 18, 2021  MONGOC_CLIENT_SESSION_APPEND(3)
Impressum