Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
libssh2_channel_setenv_ex(3)	     libssh2	    libssh2_channel_setenv_ex(3)

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  in-
     stance.

     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 LIBSSH2_ERROR_EAGAIN
     when  it  would  otherwise  block. While LIBSSH2_ERROR_EAGAIN is a negative
     number, it is not 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 -

SEE ALSO
     libssh2_channel_open_ex(3)

libssh2 0.15			   1 Jun 2007	    libssh2_channel_setenv_ex(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=libssh2_channel_setenv_ex&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help