libssh2_channel_setenv_ex.3 (1478B)
1.TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_setenv_ex - set an environment variable on the channel 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, 10 char *varname, unsigned int varname_len, 11 const char *value, unsigned int value_len); 12 13int 14libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, 15 char *varname, const char *value); 16.fi 17.SH DESCRIPTION 18\fIchannel\fP - Previously opened channel instance such as returned by 19.BR libssh2_channel_open_ex(3) 20 21\fIvarname\fP - Name of environment variable to set on the remote 22channel instance. 23 24\fIvarname_len\fP - Length of passed varname parameter. 25 26\fIvalue\fP - Value to set varname to. 27 28\fIvalue_len\fP - Length of value parameter. 29 30Set an environment variable in the remote channel's process space. Note that 31this does not make sense for all channel types and may be ignored by the 32server despite returning success. 33.SH RETURN VALUE 34Return 0 on success or negative on failure. It returns 35LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 36LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 37 38.SH ERRORS 39\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 40 41\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 42 43\fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - 44.SH SEE ALSO 45.BR libssh2_channel_open_ex(3)