libssh2_channel_setenv_ex - set an environment variable on the channel
#include <libssh2.h> int libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len); int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value);
libssh2 manual libssh2_channel_setenv_ex(3ssh2)
NAME
libssh2_channel_setenv_ex - set an environment variable on the channel
SYNOPSIS
#include <libssh2.h>
int libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname,
unsigned int varname_len, const char *value, unsigned int value_len);
int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname,
const char *value);
DESCRIPTION
channel - Previously opened channel instance such as returned by lib-
ssh2_channel_open_ex(3)
varname - Name of environment variable to set on the remote channel
instance.
varname_len - Length of passed varname parameter.
value - Value to set varname to.
value_len - Length of value parameter.
Set an environment variable in the remote channel's process space. Note
that this does not make sense for all channel types and may be ignored
by the server despite returning success.
RETURN VALUE
Return 0 on success or negative on failure. It returns LIB-
SSH2_ERROR_EAGAIN when it would otherwise block. While LIB-
SSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per
se.
ERRORS
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED -
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_channel_open_ex(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 0.15 1 Jun 2007
libssh2_channel_setenv_ex(3ssh2)