- sftp_async_read
int sftp_async_read(sftp_file file, void* data, uint len, uint id)
@brief Wait for an asynchronous read to complete and save the data.
- sftp_async_read_begin
int sftp_async_read_begin(sftp_file file, uint len)
@brief Start an asynchronous read from a file using an opened sftp file handle.
- sftp_attributes_free
void sftp_attributes_free(sftp_attributes file)
@brief Free a sftp attribute structure.
- sftp_canonicalize_path
char* sftp_canonicalize_path(sftp_session sftp, char* path)
@brief Canonicalize a sftp path.
- sftp_chmod
int sftp_chmod(sftp_session sftp, char* file, mode_t mode)
@brief Change permissions of a file
- sftp_chown
int sftp_chown(sftp_session sftp, char* file, uid_t owner, gid_t group)
@brief Change the file owner and group
- sftp_close
int sftp_close(sftp_file file)
@brief Close an open file handle.
- sftp_closedir
int sftp_closedir(sftp_dir dir)
@brief Close a directory handle opened by sftp_opendir().
- sftp_dir_eof
int sftp_dir_eof(sftp_dir dir)
@brief Tell if the directory has reached EOF (End Of File).
- sftp_extension_supported
int sftp_extension_supported(sftp_session sftp, char* name, char* data)
@brief Check if the given extension is supported.
- sftp_extensions_get_count
uint sftp_extensions_get_count(sftp_session sftp)
@brief Get the count of extensions provided by the server.
- sftp_extensions_get_data
const(char)* sftp_extensions_get_data(sftp_session sftp, uint indexn)
@brief Get the data of the extension provided by the server.
- sftp_extensions_get_name
const(char)* sftp_extensions_get_name(sftp_session sftp, uint indexn)
@brief Get the name of the extension provided by the server.
- sftp_file_set_blocking
void sftp_file_set_blocking(sftp_file handle)
@brief Make the sftp communication for this file handle blocking.
- sftp_file_set_nonblocking
void sftp_file_set_nonblocking(sftp_file handle)
@brief Make the sftp communication for this file handle non blocking.
- sftp_free
void sftp_free(sftp_session sftp)
@brief Close and deallocate a sftp session.
- sftp_fstat
sftp_attributes sftp_fstat(sftp_file file)
@brief Get information about a file or directory from a file handle.
- sftp_fstatvfs
sftp_statvfs_t sftp_fstatvfs(sftp_file file)
@brief Get information about a mounted file system.
- sftp_get_error
int sftp_get_error(sftp_session sftp)
@brief Get the last sftp error.
- sftp_init
int sftp_init(sftp_session sftp)
@brief Initialize the sftp session with the server.
- sftp_lstat
sftp_attributes sftp_lstat(sftp_session session, char* path)
@brief Get information about a file or directory.
- sftp_mkdir
int sftp_mkdir(sftp_session sftp, char* directory, mode_t mode)
@brief Create a directory.
- sftp_new
sftp_session sftp_new(ssh_session session)
@brief Start a new sftp session.
- sftp_new_channel
sftp_session sftp_new_channel(ssh_session session, ssh_channel channel)
@brief Start a new sftp session with an existing channel.
- sftp_open
sftp_file sftp_open(sftp_session session, char* file, int accesstype, mode_t mode)
@brief Open a file on the server.
- sftp_opendir
sftp_dir sftp_opendir(sftp_session session, char* path)
@brief Open a directory used to obtain directory entries.
- sftp_read
ptrdiff_t sftp_read(sftp_file file, void* buf, size_t count)
@brief Read from a file using an opened sftp file handle.
- sftp_readdir
sftp_attributes sftp_readdir(sftp_session session, sftp_dir dir)
@brief Get a single file attributes structure of a directory.
- sftp_readlink
char* sftp_readlink(sftp_session sftp, char* path)
@brief Read the value of a symbolic link.
- sftp_rename
int sftp_rename(sftp_session sftp, char* original, char* newname)
@brief Rename or move a file or directory.
- sftp_rewind
void sftp_rewind(sftp_file file)
@brief Rewinds the position of the file pointer to the beginning of the
file.
- sftp_rmdir
int sftp_rmdir(sftp_session sftp, char* directory)
@brief Remove a directoy.
- sftp_seek
int sftp_seek(sftp_file file, uint new_offset)
@brief Seek to a specific location in a file.
- sftp_seek64
int sftp_seek64(sftp_file file, ulong new_offset)
@brief Seek to a specific location in a file. This is the
64bit version.
- sftp_server_init
int sftp_server_init(sftp_session sftp)
@brief Intialize the sftp server.
- sftp_server_new
sftp_session sftp_server_new(ssh_session session, ssh_channel chan)
@brief Create a new sftp server session.
- sftp_server_version
int sftp_server_version(sftp_session sftp)
@brief Get the version of the SFTP protocol supported by the server
- sftp_setstat
int sftp_setstat(sftp_session sftp, char* file, sftp_attributes attr)
@brief Set file attributes on a file, directory or symbolic link.
- sftp_stat
sftp_attributes sftp_stat(sftp_session session, char* path)
@brief Get information about a file or directory.
- sftp_statvfs
sftp_statvfs_t sftp_statvfs(sftp_session sftp, char* path)
@brief Get information about a mounted file system.
- sftp_statvfs_free
void sftp_statvfs_free(sftp_statvfs_t statvfs_o)
@brief Free the memory of an allocated statvfs.
- sftp_symlink
int sftp_symlink(sftp_session sftp, char* target, char* dest)
@brief Create a symbolic link.
- sftp_tell
uint sftp_tell(sftp_file file)
@brief Report current byte position in file.
- sftp_tell64
ulong sftp_tell64(sftp_file file)
@brief Report current byte position in file.
- sftp_unlink
int sftp_unlink(sftp_session sftp, char* file)
@brief Unlink (delete) a file.
- sftp_utimes
int sftp_utimes(sftp_session sftp, char* file, timeval* times)
@brief Change the last modification and access time of a file.
- sftp_write
ptrdiff_t sftp_write(sftp_file file, void* buf, size_t count)
@brief Write to a file using an opened sftp file handle.
- LIBSFTP_VERSION
enum LIBSFTP_VERSION;
Undocumented in source.
- SFTP_CLOSE
enum SFTP_CLOSE;
Undocumented in source.
- SFTP_FSETSTAT
enum SFTP_FSETSTAT;
Undocumented in source.
- SFTP_FSTAT
enum SFTP_FSTAT;
Undocumented in source.
- SFTP_LSTAT
enum SFTP_LSTAT;
Undocumented in source.
- SFTP_MKDIR
enum SFTP_MKDIR;
Undocumented in source.
- SFTP_OPEN
enum SFTP_OPEN;
Undocumented in source.
- SFTP_OPENDIR
enum SFTP_OPENDIR;
Undocumented in source.
- SFTP_READ
enum SFTP_READ;
Undocumented in source.
- SFTP_READDIR
enum SFTP_READDIR;
Undocumented in source.
- SFTP_READLINK
enum SFTP_READLINK;
Undocumented in source.
- SFTP_REALPATH
enum SFTP_REALPATH;
Undocumented in source.
- SFTP_REMOVE
enum SFTP_REMOVE;
Undocumented in source.
- SFTP_RENAME
enum SFTP_RENAME;
Undocumented in source.
- SFTP_RMDIR
enum SFTP_RMDIR;
Undocumented in source.
- SFTP_SETSTAT
enum SFTP_SETSTAT;
Undocumented in source.
- SFTP_STAT
enum SFTP_STAT;
Undocumented in source.
- SFTP_SYMLINK
enum SFTP_SYMLINK;
Undocumented in source.
- SFTP_WRITE
enum SFTP_WRITE;
Undocumented in source.
- SSH_FILEXFER_ATTR_ACCESSTIME
enum SSH_FILEXFER_ATTR_ACCESSTIME;
Undocumented in source.
- SSH_FILEXFER_ATTR_ACL
enum SSH_FILEXFER_ATTR_ACL;
Undocumented in source.
- SSH_FILEXFER_ATTR_ACMODTIME
enum SSH_FILEXFER_ATTR_ACMODTIME;
Undocumented in source.
- SSH_FILEXFER_ATTR_CREATETIME
enum SSH_FILEXFER_ATTR_CREATETIME;
Undocumented in source.
- SSH_FILEXFER_ATTR_EXTENDED
enum SSH_FILEXFER_ATTR_EXTENDED;
Undocumented in source.
- SSH_FILEXFER_ATTR_MODIFYTIME
enum SSH_FILEXFER_ATTR_MODIFYTIME;
Undocumented in source.
- SSH_FILEXFER_ATTR_OWNERGROUP
enum SSH_FILEXFER_ATTR_OWNERGROUP;
Undocumented in source.
- SSH_FILEXFER_ATTR_PERMISSIONS
enum SSH_FILEXFER_ATTR_PERMISSIONS;
Undocumented in source.
- SSH_FILEXFER_ATTR_SIZE
enum SSH_FILEXFER_ATTR_SIZE;
Undocumented in source.
- SSH_FILEXFER_ATTR_SUBSECOND_TIMES
enum SSH_FILEXFER_ATTR_SUBSECOND_TIMES;
Undocumented in source.
- SSH_FILEXFER_ATTR_UIDGID
enum SSH_FILEXFER_ATTR_UIDGID;
Undocumented in source.
- SSH_FILEXFER_TYPE_DIRECTORY
enum SSH_FILEXFER_TYPE_DIRECTORY;
Undocumented in source.
- SSH_FILEXFER_TYPE_REGULAR
enum SSH_FILEXFER_TYPE_REGULAR;
Undocumented in source.
- SSH_FILEXFER_TYPE_SPECIAL
enum SSH_FILEXFER_TYPE_SPECIAL;
Undocumented in source.
- SSH_FILEXFER_TYPE_SYMLINK
enum SSH_FILEXFER_TYPE_SYMLINK;
Undocumented in source.
- SSH_FILEXFER_TYPE_UNKNOWN
enum SSH_FILEXFER_TYPE_UNKNOWN;
Undocumented in source.
- SSH_FXE_STATVFS_ST_NOSUID
enum SSH_FXE_STATVFS_ST_NOSUID;
Undocumented in source.
- SSH_FXE_STATVFS_ST_RDONLY
enum SSH_FXE_STATVFS_ST_RDONLY;
Undocumented in source.
- SSH_FXF_APPEND
enum SSH_FXF_APPEND;
Undocumented in source.
- SSH_FXF_CREAT
enum SSH_FXF_CREAT;
Undocumented in source.
- SSH_FXF_EXCL
enum SSH_FXF_EXCL;
Undocumented in source.
- SSH_FXF_READ
enum SSH_FXF_READ;
- SSH_FXF_RENAME_ATOMIC
enum SSH_FXF_RENAME_ATOMIC;
Undocumented in source.
- SSH_FXF_RENAME_NATIVE
enum SSH_FXF_RENAME_NATIVE;
Undocumented in source.
- SSH_FXF_RENAME_OVERWRITE
enum SSH_FXF_RENAME_OVERWRITE;
Undocumented in source.
- SSH_FXF_TEXT
enum SSH_FXF_TEXT;
Undocumented in source.
- SSH_FXF_TRUNC
enum SSH_FXF_TRUNC;
Undocumented in source.
- SSH_FXF_WRITE
enum SSH_FXF_WRITE;
Undocumented in source.
- SSH_FXP_ATTRS
enum SSH_FXP_ATTRS;
Undocumented in source.
- SSH_FXP_CLOSE
enum SSH_FXP_CLOSE;
Undocumented in source.
- SSH_FXP_DATA
enum SSH_FXP_DATA;
Undocumented in source.
- SSH_FXP_EXTENDED
enum SSH_FXP_EXTENDED;
Undocumented in source.
- SSH_FXP_EXTENDED_REPLY
enum SSH_FXP_EXTENDED_REPLY;
Undocumented in source.
- SSH_FXP_FSETSTAT
enum SSH_FXP_FSETSTAT;
Undocumented in source.
- SSH_FXP_FSTAT
enum SSH_FXP_FSTAT;
Undocumented in source.
- SSH_FXP_HANDLE
enum SSH_FXP_HANDLE;
Undocumented in source.
- SSH_FXP_INIT
enum SSH_FXP_INIT;
Undocumented in source.
- SSH_FXP_LSTAT
enum SSH_FXP_LSTAT;
Undocumented in source.
- SSH_FXP_MKDIR
enum SSH_FXP_MKDIR;
Undocumented in source.
- SSH_FXP_NAME
enum SSH_FXP_NAME;
Undocumented in source.
- SSH_FXP_OPEN
enum SSH_FXP_OPEN;
Undocumented in source.
- SSH_FXP_OPENDIR
enum SSH_FXP_OPENDIR;
Undocumented in source.
- SSH_FXP_READ
enum SSH_FXP_READ;
Undocumented in source.
- SSH_FXP_READDIR
enum SSH_FXP_READDIR;
Undocumented in source.
- SSH_FXP_READLINK
enum SSH_FXP_READLINK;
Undocumented in source.
- SSH_FXP_REALPATH
enum SSH_FXP_REALPATH;
Undocumented in source.
- SSH_FXP_REMOVE
enum SSH_FXP_REMOVE;
Undocumented in source.
- SSH_FXP_RENAME
enum SSH_FXP_RENAME;
Undocumented in source.
- SSH_FXP_RMDIR
enum SSH_FXP_RMDIR;
Undocumented in source.
- SSH_FXP_SETSTAT
enum SSH_FXP_SETSTAT;
Undocumented in source.
- SSH_FXP_STAT
enum SSH_FXP_STAT;
Undocumented in source.
- SSH_FXP_STATUS
enum SSH_FXP_STATUS;
Undocumented in source.
- SSH_FXP_SYMLINK
enum SSH_FXP_SYMLINK;
Undocumented in source.
- SSH_FXP_VERSION
enum SSH_FXP_VERSION;
Undocumented in source.
- SSH_FXP_WRITE
enum SSH_FXP_WRITE;
Undocumented in source.
- SSH_FX_BAD_MESSAGE
enum SSH_FX_BAD_MESSAGE;
Garbage received from server
- SSH_FX_CONNECTION_LOST
enum SSH_FX_CONNECTION_LOST;
There was a connection, but we lost it
- SSH_FX_EOF
enum SSH_FX_EOF;
- SSH_FX_FAILURE
enum SSH_FX_FAILURE;
- SSH_FX_FILE_ALREADY_EXISTS
enum SSH_FX_FILE_ALREADY_EXISTS;
An attempt to create an already existing file or directory has been made
- SSH_FX_INVALID_HANDLE
enum SSH_FX_INVALID_HANDLE;
- SSH_FX_NO_CONNECTION
enum SSH_FX_NO_CONNECTION;
No connection has been set up
- SSH_FX_NO_MEDIA
enum SSH_FX_NO_MEDIA;
- SSH_FX_NO_SUCH_FILE
enum SSH_FX_NO_SUCH_FILE;
- SSH_FX_NO_SUCH_PATH
enum SSH_FX_NO_SUCH_PATH;
No such file or directory path exists
- SSH_FX_OK
enum SSH_FX_OK;
- SSH_FX_OP_UNSUPPORTED
enum SSH_FX_OP_UNSUPPORTED;
Operation not supported by the server
- SSH_FX_PERMISSION_DENIED
enum SSH_FX_PERMISSION_DENIED;
- SSH_FX_WRITE_PROTECT
enum SSH_FX_WRITE_PROTECT;
We are trying to write on a write-protected filesystem