Section 3: library functions
libssh2_sftp_mkdir_ex – create a directory on the remote file system Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, long mode); int libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) path – full path of the new directory to create. Note that the new…
libssh2_sftp_mkdir – convenience macro for libssh2_sftp_mkdir_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_mkdir_ex(3). Return ValueSee libssh2_sftp_mkdir_ex(3) ErrorsSee libssh2_sftp_mkdir_ex(3) See Alsolibssh2_sftp_mkdir_ex(3)
libssh2_sftp_lstat – convenience macro for libssh2_sftp_stat_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_stat_ex(3). Return ValueSee libssh2_sftp_stat_ex(3) ErrorsSee libssh2_sftp_stat_ex(3) See Alsolibssh2_sftp_stat_ex(3)
libssh2_sftp_last_error – return the last SFTP-specific error code Synopsis#include <libssh2.h> #include <libssh2_sftp.h> unsigned long libssh2_sftp_last_error(LIBSSH2_SFTP *sftp); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) Returns the last error code produced by the SFTP layer. Note that this only returns a sensible error code if libssh2 returned LIBSSH2_ERROR_SFTP_PROTOCOL in a previous call. Using libssh2_sftp_last_error(3) without a…
libssh2_sftp_init – open SFTP channel for the given SSH session. Synopsis#include <libssh2.h> #include <libssh2_sftp.h> LIBSSH2_SFTP * libssh2_sftp_init(LIBSSH2_SESSION *session); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem operates over the same type of channel as those exported by the Channel API, the protocol itself…
libssh2_sftp_get_channel – return the channel of sftp Synopsis#include <libssh2.h> #include <libssh2_sftp.h>LIBSSH2_CHANNEL *libssh2_sftp_get_channel(LIBSSH2_SFTP *sftp); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) Return the channel of the given sftp handle. Return ValueThe channel of the SFTP instance or NULL if something was wrong. AvailabilityAdded in 1.4.0 See Alsolibssh2_sftp_init(3)
libssh2_sftp_statvfs, libssh2_sftp_fstatvfs – get file system statistics Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_statvfs(LIBSSH2_SFTP *sftp, const char *path, size_t path_len, LIBSSH2_SFTP_STATVFS *st); int libssh2_sftp_fstatvfs(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_STATVFS *st)DescriptionThese functions provide statvfs(2)-like operations and require statvfs [at] openssh.com and fstatvfs [at] openssh.com extension support on the server. sftp – SFTP instance as returned by libssh2_sftp_init(3) handle – SFTP…
libssh2_sftp_fstat_ex – get or set attributes on an SFTP file handle Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat) #define libbssh2_sftp_fstat(handle, attrs) \ libssh2_sftp_fstat_ex((handle), (attrs), 0) #define libssh2_sftp_fsetstat(handle, attrs) \ libssh2_sftp_fstat_ex((handle), (attrs), 1)Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) attrs – Pointer to an LIBSSH2_SFTP_ATTRIBUTES structure to set file metadata…
libssh2_sftp_fstat – convenience macro for libssh2_sftp_fstat_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_fstat_ex(3). Return ValueSee libssh2_sftp_fstat_ex(3) ErrorsSee libssh2_sftp_fstat_ex(3) See Alsolibssh2_sftp_fstat_ex(3)
libssh2_sftp_fsetstat – convenience macro for libssh2_sftp_fstat_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_fstat_ex(3). Return ValueSee libssh2_sftp_fstat_ex(3) ErrorsSee libssh2_sftp_fstat_ex(3) See Alsolibssh2_sftp_fstat_ex(3)
libssh2_sftp_closedir – convenience macro for libssh2_sftp_close_handle(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle) DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_close_handle(3). Return ValueSee libssh2_sftp_close_handle(3) ErrorsSee libssh2_sftp_close_handle(3) See Alsolibssh2_sftp_close_handle(3)
libssh2_sftp_close_handle – close filehandle Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle); int libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); int libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle); Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) or libssh2_sftp_opendir(3) (which is a macro). Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the same underlying storage mechanism these methods may be used interchangably. libssh2_sftp_close(3) and libssh2_sftp_closedir(3)…
libssh2_sftp_close – convenience macro for libssh2_sftp_close_handle(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_close_handle(3). Return ValueSee libssh2_sftp_close_handle(3) ErrorsSee libssh2_sftp_close_handle(3) See Alsolibssh2_sftp_close_handle(3)
libssh2_session_supported_algs – get list of supported algorithms Synopsis#include <libssh2.h> int libssh2_session_supported_algs(LIBSSH2_SESSION* session, int method_type, const char*** algs);Descriptionsession – An instance of initialized LIBSSH2_SESSION (the function will use its pointer to the memory allocation function). method_type – Method type. See .BR libssh2_session_method_pref(3). algs – Address of a pointer that will point to an array af returned…
libssh2_session_startup – begin transport layer Synopsis#include <libssh2.h> int libssh2_session_startup(LIBSSH2_SESSION *session, int socket); DescriptionStarting in libssh2 version 1.2.8 this function is considered deprecated. Use libssh2_session_handshake(3) instead. session – Session instance as returned by libssh2_session_init_ex(3) socket – Connected socket descriptor. Typically a TCP connection though the protocol allows for any reliable transport and the library will attempt…
libssh2_session_set_timeout – set timeout for blocking functions Synopsis#include <libssh2.h> void libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout);DescriptionSet the timeout in milliseconds for how long a blocking the libssh2 function calls may wait until they consider the situation an error and return LIBSSH2_ERROR_TIMEOUT. By default or if you set the timeout to zero, libssh2 has no timeout for blocking…
libssh2_session_set_blocking – set or clear blocking mode on session Synopsis#include <libssh2.h> void libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking); Descriptionsession – session instance as returned by libssh2_session_init_ex(3) blocking – Set to a non-zero value to make the channel block, or zero to make it non-blocking. Set or clear blocking mode on the selected on the session. This will…
libssh2_session_methods – return the currently active algorithms Synopsis#include <libssh2.h> const char * libssh2_session_methods(LIBSSH2_SESSION *session, int method_type); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) method_type – one of the method type constants: LIBSSH2_METHOD_KEX, LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC, LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS, LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC. Returns the actual method negotiated for a particular transport parameter. Return ValueNegotiated method…
libssh2_session_method_pref – set preferred key exchange method Synopsis#include <libssh2.h> int libssh2_session_method_pref(LIBSSH2_SESSION *session, int method_type, const char *prefs); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) method_type – One of the Method Type constants. prefs – Coma delimited list of preferred methods to use with the most preferred listed first and the least preferred listed last….
libssh2_session_last_error – get the most recent error Synopsis#include <libssh2.h> int libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg, int *errmsg_len, int want_buf); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) errmsg – If not NULL, is populated by reference with the human readable form of the most recent error message. errmsg_len – If not NULL, is populated by reference…