Scroll to navigation

MONGOC_CLIENT_SESSION_APPEND(3) libmongoc MONGOC_CLIENT_SESSION_APPEND(3)

SYNOPSIS

bool
mongoc_client_session_append (const mongoc_client_session_t *client_session,

bson_t *opts,
bson_error_t *error);


PARAMETERS


DESCRIPTION

This function appends a logical session id to command options. Use it to configure a session for any function that takes an options document, such as mongoc_client_write_command_with_opts() <>.

It is an error to use a session for unacknowledged writes.

RETURNS

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

EXAMPLE

See the example code for mongoc_client_session_t <>.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

November 26, 2025 2.2.0