NAME libssh2_sftp_shutdown – shut down an SFTP session SYNOPSIS #include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); DESCRIPTION sftp – SFTP instance as returned by libssh2_sftp_init(3) Destroys a previously initialized SFTP session and frees all resources associated with it. RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise…
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_stat_ex(3). RETURN VALUE See libssh2_sftp_stat_ex(3) ERRORS See libssh2_sftp_stat_ex(3) SEE ALSO libssh2_sftp_stat_ex(3) Index
NAME 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); DESCRIPTION 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 implements…
NAME 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); DESCRIPTION Deprecated 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…
NAME 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); DESCRIPTION Remove 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…
NAME 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)) DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_rmdir_ex(3). RETURN VALUE See libssh2_sftp_rmdir_ex(3) ERRORS See libssh2_sftp_rmdir_ex(3) SEE ALSO libssh2_sftp_rmdir_ex(3) Index
NAME libssh2_sftp_rewind – convenience macro for libssh2_sftp_seek64(3) calls SYNOPSIS #include <libssh2.h> int libssh2_sftp_rewind(LINBSSH2_SFTP_HANDLE *handle); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_seek64(3). RETURN VALUE See libssh2_sftp_seek64(3) ERRORS See libssh2_sftp_seek64(3) SEE ALSO libssh2_sftp_seek64(3) Index
NAME 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); DESCRIPTION sftp – SFTP instance as returned by libssh2_sftp_init(3) sourcefile – Path and name of the existing…
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_rename_ex(3). RETURN VALUE See libssh2_sftp_rename_ex(3) ERRORS See libssh2_sftp_rename_ex(3) SEE ALSO libssh2_sftp_rename_ex(3) Index
NAME 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) DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_symlink_ex(3). RETURN VALUE See libssh2_sftp_symlink_ex(3) ERRORS See libssh2_sftp_symlink_ex(3) SEE ALSO libssh2_sftp_symlink_ex(3) Index
NAME 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) DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_symlink_ex(3). RETURN VALUE See libssh2_sftp_symlink_ex(3) ERRORS See libssh2_sftp_symlink_ex(3) SEE ALSO libssh2_sftp_symlink_ex(3) Index
NAME 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); DESCRIPTION Reads 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…
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_readdir_ex(3). RETURN VALUE See libssh2_sftp_readdir_ex(3) ERRORS See libssh2_sftp_readdir_ex(3) SEE ALSO libssh2_sftp_readdir_ex(3) Index
NAME 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); DESCRIPTION handle 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…
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_open_ex(3). RETURN VALUE See libssh2_sftp_open_ex(3) ERRORS See libssh2_sftp_open_ex(3) SEE ALSO libssh2_sftp_open_ex(3) Index
NAME 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); DESCRIPTION sftp – SFTP instance as returned by libssh2_sftp_init(3) filename – Remote file/directory resource to open filename_len – Length of filename flags – Any…
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_open_ex(3). RETURN VALUE See libssh2_sftp_open_ex(3) ERRORS See libssh2_sftp_open_ex(3) SEE ALSO libssh2_sftp_open_ex(3) Index
NAME 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); DESCRIPTION sftp – SFTP instance as returned by libssh2_sftp_init(3) path – full path of the new directory to create. Note…
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_mkdir_ex(3). RETURN VALUE See libssh2_sftp_mkdir_ex(3) ERRORS See libssh2_sftp_mkdir_ex(3) SEE ALSO libssh2_sftp_mkdir_ex(3) Index
NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_stat_ex(3). RETURN VALUE See libssh2_sftp_stat_ex(3) ERRORS See libssh2_sftp_stat_ex(3) SEE ALSO libssh2_sftp_stat_ex(3) Index