libssh2_sftp_rewind – convenience macro for libssh2_sftp_seek64(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_rewind(LINBSSH2_SFTP_HANDLE *handle); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_seek64(3). Return ValueSee libssh2_sftp_seek64(3) ErrorsSee libssh2_sftp_seek64(3) See Alsolibssh2_sftp_seek64(3)
libssh2_sftp_rename_ex – rename an SFTP file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, const char *source_filename, unsigned int source_filename_len, const char *dest_filename, unsigned int dest_filename_len, long flags); int libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, const char *source_filename, const char *dest_filename); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) sourcefile – Path and name of the existing filesystem entry sourcefile_len…
libssh2_sftp_rename – convenience macro for libssh2_sftp_rename_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_rename(LIBSSH2_SFTP *sftp, const char *source_filename, const char *destination_filename); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_rename_ex(3). Return ValueSee libssh2_sftp_rename_ex(3) ErrorsSee libssh2_sftp_rename_ex(3) See Alsolibssh2_sftp_rename_ex(3)
libssh2_sftp_realpath – convenience macro for libssh2_sftp_symlink_ex(3) Synopsis#include <libssh2.h> #define libssh2_sftp_realpath(sftp, path, target, maxlen) \ libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \ LIBSSH2_SFTP_REALPATH)DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_symlink_ex(3). Return ValueSee libssh2_sftp_symlink_ex(3) ErrorsSee libssh2_sftp_symlink_ex(3) See Alsolibssh2_sftp_symlink_ex(3)
libssh2_sftp_readlink – convenience macro for libssh2_sftp_symlink_ex(3) Synopsis#include <libssh2.h> #define libssh2_sftp_readlink(sftp, path, target, maxlen) \ libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \ LIBSSH2_SFTP_READLINK)DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_symlink_ex(3). Return ValueSee libssh2_sftp_symlink_ex(3) ErrorsSee libssh2_sftp_symlink_ex(3) See Alsolibssh2_sftp_symlink_ex(3)
libssh2_sftp_readdir_ex – read directory data from an SFTP handle Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, char *longentry, size_t longentry_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);DescriptionReads a block of data from a LIBSSH2_SFTP_HANDLE and returns file entry information for the next entry, if any. handle – is the SFTP File Handle as returned by libssh2_sftp_open_ex(3)…
libssh2_sftp_readdir – convenience macro for libssh2_sftp_readdir_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_readdir_ex(3). Return ValueSee libssh2_sftp_readdir_ex(3) ErrorsSee libssh2_sftp_readdir_ex(3) See Alsolibssh2_sftp_readdir_ex(3)
libssh2_sftp_read – read data from an SFTP handle Synopsis#include <libssh2.h> #include <libssh2_sftp.h> ssize_t libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen); Descriptionhandle is the SFTP File Handle as returned by libssh2_sftp_open_ex(3) buffer is a pointer to a pre-allocated buffer of at least buffer_maxlen bytes to read data into. Reads a block of data from an LIBSSH2_SFTP_HANDLE. This…
libssh2_sftp_opendir – convenience macro for libssh2_sftp_open_ex(3) calls Synopsis#include <libssh2.h> LIBSSH2_SFTP_HANDLE * libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_open_ex(3). Return ValueSee libssh2_sftp_open_ex(3) ErrorsSee libssh2_sftp_open_ex(3) See Alsolibssh2_sftp_open_ex(3)
libssh2_sftp_open – open filehandle for file on SFTP. Synopsis#include <libssh2.h> #include <libssh2_sftp.h> LIBSSH2_SFTP_HANDLE * libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len, unsigned long flags, long mode, int open_type);Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) filename – Remote file/directory resource to open filename_len – Length of filename flags – Any reasonable combination of the…
libssh2_sftp_open – convenience macro for libssh2_sftp_open_ex(3) calls Synopsis#include <libssh2.h> LIBSSH2_SFTP_HANDLE * libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *path, unsigned long flags, long mode); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_open_ex(3). Return ValueSee libssh2_sftp_open_ex(3) ErrorsSee libssh2_sftp_open_ex(3) See Alsolibssh2_sftp_open_ex(3)
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)