Skip to content

Add box_session_id() C API reference #3597

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jul 31, 2023
Merged

Add box_session_id() C API reference #3597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/dev_guide/reference_capi/box.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,15 @@

:return: 0 on success and -1 otherwise. In case of an error user
could get it via ``box_error_last()``.

.. _box_box_session_id:

.. c:function:: uint64_t box_session_id(void);

Since version :doc:`2.11.0 </release/2.11.0>`.
Return the unique identifier (ID) for the current session.

:return: the unique identifier (ID) for the current session
:return: 0 or -1 if there is no session

See also :ref:`box.session.id()<box_session-id>`