| Class | Description | |
|---|---|---|
 | Attrs | SFTP Version 6: 7. File Attributes A new compound data type, 'ATTRS', is defined for encoding file attributes. The same encoding is used both when returning file attributes from the server and when sending file attributes to the server. uint32 valid-attribute-flags byte type always present uint64 size if flag SIZE uint64 allocation-size if flag ALLOCATION_SIZE string owner if flag OWNERGROUP string group if flag OWNERGROUP uint32 permissions if flag PERMISSIONS int64 atime if flag ACCESSTIME uint32 atime-nseconds if flag SUBSECOND_TIMES int64 createtime if flag CREATETIME uint32 createtime-nseconds if flag SUBSECOND_TIMES int64 mtime if flag MODIFYTIME uint32 mtime-nseconds if flag SUBSECOND_TIMES int64 ctime if flag CTIME uint32 ctime-nseconds if flag SUBSECOND_TIMES string acl if flag ACL uint32 attrib-bits if flag BITS uint32 attrib-bits-valid if flag BITS byte text-hint if flag TEXT_HINT string mime-type if flag MIME_TYPE uint32 link-count if flag LINK_COUNT string untranslated-name if flag UNTRANSLATED_NAME uint32 extended-count if flag EXTENDED extension-pair extensions SFTP Version 3: 5. File Attributes uint32 flags uint64 size present only if flag SSH_FILEXFER_ATTR_SIZE uint32 uid present only if flag SSH_FILEXFER_ATTR_UIDGID uint32 gid present only if flag SSH_FILEXFER_ATTR_UIDGID uint32 permissions present only if flag SSH_FILEXFER_ATTR_PERMISSIONS uint32 atime present only if flag SSH_FILEXFER_ACMODTIME uint32 mtime present only if flag SSH_FILEXFER_ACMODTIME uint32 extended_count present only if flag SSH_FILEXFER_ATTR_EXTENDED string extended_type string extended_data ... more extended data (extended_type - extended_data pairs), so that number of pairs equals extended_count |
| AttrsResponsePayload | SFTP Version 6: 9.5. Attrs Response byte SSH_FXP_ATTRS uint32 request-id ATTRS attrs |
| CloseHandlePayload | SFTP Version 6: 8.1.3. Closing Handles byte SSH_FXP_CLOSE uint32 request-id string handle |
| CreateDirectoryPayload | SFTP Version 6: 8.4. Creating and Deleting Directories byte SSH_FXP_MKDIR uint32 request-id string path [UTF-8] ATTRS attrs where 'request-id' is the request identifier. 'path' specifies the directory to be created. See Section ''File Names'' for more information on file names. 'attrs' specifies the attributes that should be applied to it upon creation. Attributes are discussed in more detail in Section ''File Attributes''. The server will respond to this request with a SSH_FXP_STATUS message. If a file or directory with the specified path already exists, an error will be returned. |
| DataResponsePayload | SFTP Version 6: 9.3. Data Response byte SSH_FXP_DATA uint32 request-id string data bool end-of-file [optional] |
| ExtendedRequestBasePayload | SFTP Version 6: 10. Extensions The SSH_FXP_EXTENDED request provides a generic extension mechanism for adding additional commands. byte SSH_FXP_EXTENDED string extended-request ... any request-specific data ... |
| ExtensionPair | SFTP Version 6: 7. File Attributes A new compound data type, 'ATTRS', is defined for encoding file attributes. The same encoding is used both when returning file attributes from the server and when sending file attributes to the server. string extension-name string extension-data |
| FilenameAttributesPair | SFTP Version 6: 9.4. Name Response string filename [UTF-8] ATTRS attrs SFTP Version 3: 7. Responses from the Server to the Client string filename [UTF-8] string longname [UTF-8] ATTRS attrs |
| GetFileAttributesPayload | SFTP Version 6: 8.5. Retrieving File Attributes byte SSH_FXP_STAT uint32 request-id string path [UTF-8] uint32 flags where 'request-id' is the request identifier, and 'path' specifies the file system object for which status is to be returned. The server responds to this request with either SSH_FXP_ATTRS or SSH_FXP_STATUS. The flags field specify the attribute flags in which the client has particular interest. This is a hint to the server. For example, because retrieving owner / group and acl information can be an expensive operation under some operating systems, the server may choose not to retrieve this information unless the client expresses a specific interest in it. The client has no guarantee the server will provide all the fields that it has expressed an interest in. SFTP Version 3: 6.8 Retrieving File Attributes uint32 id string path where `id' is the request identifier, and `path' specifies the file system object for which status is to be returned. The server responds to this request with either SSH_FXP_ATTRS or SSH_FXP_STATUS. |
| GetHandleAttributesPayload | SFTP Version 6: 8.5. Retrieving File Attributes byte SSH_FXP_STAT uint32 request-id string handle uint32 flags |
| GetOpenFileAttributesPayload | SFTP Version 6: 8.5. Retrieving File Attributes SSH_FXP_FSTAT differs from the others in that it returns status information for an open file (identified by the file handle). byte SSH_FXP_FSTAT uint32 request-id string handle uint32 flags handle 'handle' is an open file handle from either SSH_FXP_OPEN or SSH_FXP_OPENDIR. The server responds to this request with SSH_FXP_ATTRS or SSH_FXP_STATUS. The flags field specify the attribute flags in which the client has particular interest. This is a hint to the server. For example, because retrieving owner / group and acl information can be an expensive operation under some operating systems, the server may choose not to retrieve this information unless the client expresses a specific interest in it. The client has no guarantee the server will provide all the fields that it has expressed an interest in. SFTP Version 3: 6.8 Retrieving File Attributes uint32 id string handle where `id' is the request identifier and `handle' is a file handle returned by SSH_FXP_OPEN. The server responds to this request with SSH_FXP_ATTRS or SSH_FXP_STATUS. |
| HandleResponsePayload | SFTP Version 6: 9.2. Handle Response byte SSH_FXP_HANDLE uint32 request-id string handle |
| InitPayload | |
| Licenser | Class which is used to register the classes located in the Xceed.FileSystem namespace. |
| NameResponsePayload | SFTP Version 6: 9.4. Name Response byte SSH_FXP_NAME uint32 request-id uint32 count repeats count times: string filename [UTF-8] ATTRS attrs bool end-of-list [optional] SFTP Version 3: 7. Responses from the Server to the Client byte SSH_FXP_NAME uint32 id uint32 count repeats count times: string filename [UTF-8] string longname [UTF-8] ATTRS attrs |
| OpenDirectoryPayload | SFTP Version 6: 8.1.2. Opening a Directory Files are opened and created using the SSH_FXP_OPEN message. byte SSH_FXP_OPENDIR uint32 request-id string path [UTF-8] |
| OpenFilePayload | SFTP Version 6: 8.1.1. Opening a File Files are opened and created using the SSH_FXP_OPEN message. byte SSH_FXP_OPEN uint32 request-id string filename [UTF-8] uint32 desired-access uint32 flags ATTRS attrs SFTP Version 3: 6.3 Opening, Creating, and Closing Files uint32 id string filename uint32 pflags ATTRS attrs |
| ReadDirectoryPayload | SFTP Version 6: 8.2.2. Reading Directories byte SSH_FXP_READDIR uint32 request-id string handle handle 'handle' is a handle returned by SSH_FXP_OPENDIR. If 'handle' is an ordinary file handle returned by SSH_FXP_OPEN, the server MUST return SSH_FX_INVALID_HANDLE. The server responds to this request with either a SSH_FXP_NAME or a SSH_FXP_STATUS message. One or more names may be returned at a time. Full status information is returned for each name in order to speed up typical directory listings. If there are no more names available to be read, the server MUST respond with a SSH_FXP_STATUS message with error code of SSH_FX_EOF. |
| ReadFilePayload | SFTP Version 6: 8.2.1. Reading Files byte SSH_FXP_READ uint32 request-id string handle uint64 offset uint32 length |
| RealPathPayload | SFTP Version 6: 8.9. Canonicalizing the Server-Side Path Name byte SSH_FXP_REALPATH uint32 request-id string original-path [UTF-8] byte control-byte [optional] // version 6 and up string compose-path[0..n] [optional] // version 6 and up |
| RemoveDirectoryPayload | SFTP Version 6: 8.4. Creating and Deleting Directories byte SSH_FXP_RMDIR uint32 request-id string path [UTF-8] where 'request-id' is the request identifier, and 'path' specifies the directory to be removed. See Section ''File Names'' for more information on file names. The server responds to this request with a SSH_FXP_STATUS message. |
| RemoveFilePayload | SFTP Version 6: 8.3. Removing and Renaming Files byte SSH_FXP_REMOVE uint32 request-id string filename [UTF-8] |
| RenameFilePayload | SFTP Version 6: 8.3. Removing and Renaming Files byte SSH_FXP_RENAME uint32 request-id string oldpath [UTF-8] string newpath [UTF-8] uint32 flags where 'request-id' is the request identifier, 'oldpath' is the name of an existing file or directory, and 'newpath' is the new name for the file or directory. 'flags' is 0 or a combination of: SSH_FXF_RENAME_OVERWRITE 0x00000001 SSH_FXF_RENAME_ATOMIC 0x00000002 SSH_FXF_RENAME_NATIVE 0x00000004 If the server cannot support the requested mode of operation, it must return SSH_FX_OP_UNSUPPORTED. If flags does not include SSH_FXP_RENAME_OVERWRITE, and there already exists a file with the name specified by newpath, the server MUST respond with SSH_FX_FILE_ALREADY_EXISTS. If flags includes SSH_FXP_RENAME_ATOMIC, and the destination file already exists, it is replaced in an atomic fashion. I.e., there is no observable instant in time where the name does not refer to either the old or the new file. SSH_FXP_RENAME_ATOMIC implies SSH_FXP_RENAME_OVERWRITE. If 'SSH_FXP_RENAME_OVERWRITE' is not present, and the server does not support this mode natively, it MAY emulate it by checking for the existance of a file before executing the rename operation. If the 'SSH_FXF_RENAME_ATOMIC' is specified without the the 'SSH_FXP_RENAME_OVERWRITE', then the server MUST be able to perform the check and rename operation atomically. Because some servers cannot provide atomic rename, clients should only specify atomic rename if correct operation requires it. If SSH_FXP_RENAME_OVERWRITE is specified, the server MAY perform an atomic rename even if it is not requested. If flags includes SSH_FXP_RENAME_NATIVE, the server is free to do the rename operation in whatever fashion it deems appropriate. Other flag values are considered hints as to desired behavior, but not requirements. The server will respond to this request with a SSH_FXP_STATUS message. |
| SetFileAttributesPayload | SFTP Version 6: 8.6. Setting File Attributes byte SSH_FXP_SETSTAT uint32 request-id string path [UTF-8] ATTRS attrs |
| SFtp | Implements the SSH File Transfer Protocol (SFtp). |
| SFtpConstants | |
| SFtpException | |
| SFtpIOException | |
| SFtpPayload | |
| SFtpPayloadBase | |
| SFtpStatusResponseException | An exception that is thrown when a StatusResponse is received. |
| StatusResponsePayload | Represents a response from the server to the client that contains a status code. |
| UnsupportedSFtpVersionException | |
| VersionPayload | |
| VersionSelectPayload | SFTP Version 6: 10. Extensions The SSH_FXP_EXTENDED request provides a generic extension mechanism for adding additional commands. byte SSH_FXP_EXTENDED string extended-request ... any request-specific data ... |
| WriteFilePayload | SFTP Version 6: 8.2.3. Writing Files byte SSH_FXP_WRITE uint32 request-id string handle uint64 offset string data |
Xceed .NET Libraries Documentation
