Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

libssh2_sftp_open_ex(3) [centos man page]

libssh2_sftp_open_ex(3) 					  libssh2 manual					   libssh2_sftp_open_ex(3)

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 reasonable combination of the LIBSSH2_FXF_* constants: LIBSSH2_FXF_READ Open the file for reading. LIBSSH2_FXF_WRITE Open the file for writing. If both this and LIBSSH2_FXF_READ are specified, the file is opened for both reading and writing. LIBSSH2_FXF_APPEND Force all writes to append data at the end of the file. LIBSSH2_FXF_CREAT, If this flag is specified, then a new file will be created if one does not already exist (if LIBSSH2_FXF_TRUNC is specified, the new file will be truncated to zero length if it previously exists) LIBSSH2_FXF_TRUNC Forces an existing file with the same name to be truncated to zero length when creating a file by specifying LIB- SSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also be specified if this flag is used. LIBSSH2_FXF_EXCL Causes the request to fail if the named file already exists. LIBSSH2_FXF_CREAT MUST also be specified if this flag is used. mode - POSIX file permissions to assign if the file is being newly created. See the LIBSSH2_SFTP_S_* convenience defines in <lib- ssh2_sftp.h> open_type - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or LIBSSH2_SFTP_OPENDIR (to open a directory). RETURN VALUE
A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on failure. ERRORS
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed. LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket. LIBSSH2_ERROR_SOCKET_TIMEOUT - LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the call would block. SEE ALSO
libssh2_sftp_close_handle(3) libssh2 0.15 1 Jun 2007 libssh2_sftp_open_ex(3)

Check Out this Related Man Page

libssh2_sftp_statvfs(3) 					  libssh2 manual					   libssh2_sftp_statvfs(3)

NAME
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) DESCRIPTION
These functions provide statvfs(2)-like operations and require statvfs@openssh.com and fstatvfs@openssh.com extension support on the server. sftp - SFTP instance as returned by libssh2_sftp_init(3) handle - SFTP File Handle as returned by libssh2_sftp_open_ex(3) path - full path of any file within the mounted file system. path_len - length of the full path. st - Pointer to a LIBSSH2_SFTP_STATVFS structure to place file system statistics into. DATA TYPES
LIBSSH2_SFTP_STATVFS is a typedefed struct that is defined as below struct _LIBSSH2_SFTP_STATVFS { libssh2_uint64_t f_bsize; /* file system block size */ libssh2_uint64_t f_frsize; /* fragment size */ libssh2_uint64_t f_blocks; /* size of fs in f_frsize units */ libssh2_uint64_t f_bfree; /* # free blocks */ libssh2_uint64_t f_bavail; /* # free blocks for non-root */ libssh2_uint64_t f_files; /* # inodes */ libssh2_uint64_t f_ffree; /* # free inodes */ libssh2_uint64_t f_favail; /* # free inodes for non-root */ libssh2_uint64_t f_fsid; /* file system ID */ libssh2_uint64_t f_flag; /* mount flags */ libssh2_uint64_t f_namemax; /* maximum filename length */ }; It is unspecified whether all members of the returned struct have meaningful values on all file systems. The field f_flag is a bit mask. Bits are defined as follows: LIBSSH2_SFTP_ST_RDONLY Read-only file system. LIBSSH2_SFTP_ST_NOSUID Set-user-ID/set-group-ID bits are ignored by exec(3). RETURN VALUE
Returns 0 on success or negative on failure. If used in non-blocking mode, it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. ERRORS
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed. LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket. LIBSSH2_ERROR_SOCKET_TIMEOUT - LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. AVAILABILITY
Added in libssh2 1.2.6 SEE ALSO
libssh2_sftp_open_ex(3) libssh2 1.2.6 22 May 2010 libssh2_sftp_statvfs(3)
Man Page