libssh2_sftp_write – write SFTP data Synopsis#include <libssh2.h> #include <libssh2_sftp.h> ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count);Descriptionlibssh2_sftp_write(3) writes a block of data to the SFTP server. This method is modeled after the POSIX write() function and uses the same calling semantics. handle – SFTP file handle as returned by libssh2_sftp_open_ex(3). buffer – points to the…
libssh2_sftp_unlink_ex – unlink an SFTP file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len); int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) filename – Path and name of the existing filesystem entry filename_len – Length of the path and name of the existing filesystem…
libssh2_sftp_unlink – convenience macro for libssh2_sftp_unlink_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_unlink_ex(3). Return ValueSee libssh2_sftp_unlink_ex(3) ErrorsSee libssh2_sftp_unlink_ex(3) See Alsolibssh2_sftp_unlink_ex(3)
libssh2_sftp_tell64 – get the current read/write position indicator for a file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> libssh2_uint64_t libssh2_sftp_tell64(LIBSSH2_SFTP_HANDLE *handle); Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) Identify the current offset of the file handle’s internal pointer. Return ValueCurrent offset from beginning of file in bytes. AvailabilityAdded in libssh2 1.0 See Alsolibssh2_sftp_open_ex(3), libssh2_sftp_tell(3)
libssh2_sftp_tell – get the current read/write position indicator for a file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> size_t libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle); Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3). Returns the current offset of the file handle’s internal pointer. Note that this is now deprecated. Use the newer libssh2_sftp_tell64(3) instead! Return ValueCurrent offset from beginning of file…
libssh2_sftp_symlink_ex – read or set a symbolic link Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, char *target, unsigned int target_len, int link_type);DescriptionCreate a symlink or read out symlink information from the remote side. sftp – SFTP instance as returned by libssh2_sftp_init(3) path – Remote filesystem object to create a…
libssh2_sftp_symlink – convenience macro for libssh2_sftp_symlink_ex(3) Synopsis#include <libssh2.h> #define libssh2_sftp_symlink(sftp, orig, linkpath) \ libssh2_sftp_symlink_ex((sftp), (orig), strlen(orig), (linkpath), \ strlen(linkpath), LIBSSH2_SFTP_SYMLINK)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_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_stat_ex – get status about an SFTP file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, int stat_type, LIBSSH2_SFTP_ATTRIBUTES *attrs);Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) path – Remote filesystem object to stat/lstat/setstat. path_len – Length of the name of the remote filesystem object to stat/lstat/setstat. stat_type – One…
libssh2_sftp_stat – convenience macro for libssh2_sftp_fstat_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_STFP_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_shutdown – shut down an SFTP session Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) Destroys a previously initialized SFTP session and frees all resources associated with it. Return ValueReturn 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is…
libssh2_sftp_setstat – convenience macro for libssh2_sftp_stat_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attr); 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_seek64 – set the read/write position within a file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> void libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle, libssh2_uint64_t offset);Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) offset – Number of bytes from the beginning of file to seek to. Move the file handle’s internal pointer to an arbitrary location. libssh2 implements file pointers as a…
libssh2_sftp_seek – set the read/write position indicator within a file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> void libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle, size_t offset);DescriptionDeprecated function. Use libssh2_sftp_seek64(3) instead! handle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) offset – Number of bytes from the beginning of file to seek to. Move the file handle’s internal pointer to an arbitrary location….
libssh2_sftp_rmdir_ex – remove an SFTP directory Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len);DescriptionRemove a directory from the remote file system. sftp – SFTP instance as returned by libssh2_sftp_init(3) sourcefile – Full path of the existing directory to remove. sourcefile_len – Length of the full path of the existing directory…
libssh2_sftp_rmdir – convenience macro for libssh2_sftp_rmdir_ex(3) Synopsis#include <libssh2.h> #define libssh2_sftp_rmdir(sftp, path) \ libssh2_sftp_rmdir_ex((sftp), (path), strlen(path))DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_rmdir_ex(3). Return ValueSee libssh2_sftp_rmdir_ex(3) ErrorsSee libssh2_sftp_rmdir_ex(3) See Alsolibssh2_sftp_rmdir_ex(3)
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)