1
0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Files
libssh2/docs/libssh2_session_flag.md
Viktor Szakats 9a0b40af73 tidy-up: version-related comments and messages
If it improves consistency across builds and sources, prefer 'greater'
or newer/later/+, prefer no 'v'/'version` prefix.

Closes #1866
2026-08-27 03:25:32 +02:00

48 lines
1001 B
Markdown

---
c: Copyright (C) The libssh2 project and its contributors.
SPDX-License-Identifier: BSD-3-Clause
Title: libssh2_session_flag
Section: 3
Source: libssh2
See-also:
---
# NAME
libssh2_session_flag - TODO
# SYNOPSIS
~~~c
#include <libssh2.h>
int libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value);
~~~
# DESCRIPTION
Set options for the created session. *flag* is the option to set, while
*value* is typically set to 1 or 0 to enable or disable the option.
# FLAGS
## LIBSSH2_FLAG_SIGPIPE
If set, libssh2 does not attempt to block SIGPIPEs but lets them trigger
from the underlying socket layer.
## LIBSSH2_FLAG_COMPRESS
If set - before the connection negotiation is performed - libssh2 tries to
negotiate compression enabling for this connection. By default libssh2 does
not attempt to use compression.
# RETURN VALUE
Returns regular libssh2 error code.
# AVAILABILITY
This function has existed since the age of dawn. LIBSSH2_FLAG_COMPRESS was
added in libssh2 1.2.8.