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

SYNOPSIS

6          bool
7          mongoc_client_session_append (const mongoc_client_session_t *client_session,
8                                        bson_t *opts,
9                                        bson_error_t *error);
10

PARAMETERS

12       • client_session: A pointer to a mongoc_client_session_t.
13
14       • opts: A pointer to a bson_t.
15
16       • error: An optional location for a bson_error_t or NULL.
17

DESCRIPTION

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

RETURNS

26       Returns  true  on  success. If any arguments are invalid, returns false
27       and fills out error.
28

EXAMPLE

30       See the example code for mongoc_client_session_t.
31

AUTHOR

33       MongoDB, Inc
34

36       2017-present, MongoDB, Inc
37
38
39
40
411.25.1                           Nov 08, 2023  MONGOC_CLIENT_SESSION_APPEND(3)
Impressum