libssh2/share/man/man3/libssh2_channel_setenv_ex.3

   1 .\" $Id: libssh2_channel_setenv_ex.3,v 1.1 2007/06/13 21:30:15 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_setenv_ex - set an environment variable on the channel
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len);
  11
  12 int
  13 libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value);
  14
  15 .SH DESCRIPTION
  16 \fIchannel\fP - Previously opened channel instance such as returned by
  17 .BR libssh2_channel_open_session(3)
  18
  19 \fIvarname\fP - Name of environment variable to set on the remote
  20 channel instance.
  21
  22 \fIvarname_len\fP - Length of passed varname parameter.
  23
  24 \fIvalue\fP - Value to set varname to.
  25
  26 \fIvalue_len\fP - Length of value parameter.
  27
  28 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.
  29
  30 .SH RETURN VALUE
  31 Return 0 on success or negative on failure.  It returns
  32 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  33 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  34
  35 .SH ERRORS
  36 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  37
  38 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  39
  40 \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP -
  41
  42 .SH SEE ALSO
  43 .BR libssh2_channel_open_session(3)