Interface ISftpFile

Namespace

Renci.SshNet.Sftp

Assembly

Renci.SshNet.dll

Represents SFTP file information.

public interface ISftpFile

Properties

Attributes

Gets the file attributes.

SftpFileAttributes Attributes { get; }

Property Value

SftpFileAttributes

FullName

Gets the full path of the file or directory.

string FullName { get; }

Property Value

string

GroupCanExecute

Gets or sets a value indicating whether the group members can execute this file.

bool GroupCanExecute { get; set; }

Property Value

bool

GroupCanRead

Gets or sets a value indicating whether the group members can read from this file.

bool GroupCanRead { get; set; }

Property Value

bool

GroupCanWrite

Gets or sets a value indicating whether the group members can write into this file.

bool GroupCanWrite { get; set; }

Property Value

bool

GroupId

Gets or sets file group id.

int GroupId { get; set; }

Property Value

int

IsBlockDevice

Gets a value indicating whether file represents a block device.

bool IsBlockDevice { get; }

Property Value

bool

IsCharacterDevice

Gets a value indicating whether file represents a character device.

bool IsCharacterDevice { get; }

Property Value

bool

IsDirectory

Gets a value indicating whether file represents a directory.

bool IsDirectory { get; }

Property Value

bool

IsNamedPipe

Gets a value indicating whether file represents a named pipe.

bool IsNamedPipe { get; }

Property Value

bool

IsRegularFile

Gets a value indicating whether file represents a regular file.

bool IsRegularFile { get; }

Property Value

bool

IsSocket

Gets a value indicating whether file represents a socket.

bool IsSocket { get; }

Property Value

bool

IsSymbolicLink

Gets a value indicating whether file represents a symbolic link.

bool IsSymbolicLink { get; }

Property Value

bool

LastAccessTime

Gets or sets the time the current file or directory was last accessed.

DateTime LastAccessTime { get; set; }

Property Value

DateTime

LastAccessTimeUtc

Gets or sets the time, in coordinated universal time (UTC), the current file or directory was last accessed.

DateTime LastAccessTimeUtc { get; set; }

Property Value

DateTime

LastWriteTime

Gets or sets the time when the current file or directory was last written to.

DateTime LastWriteTime { get; set; }

Property Value

DateTime

LastWriteTimeUtc

Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to.

DateTime LastWriteTimeUtc { get; set; }

Property Value

DateTime

Length

Gets the size, in bytes, of the current file.

long Length { get; }

Property Value

long

Name

Gets the name of the file or directory.

string Name { get; }

Property Value

string

Remarks

For directories, this is the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.

OthersCanExecute

Gets or sets a value indicating whether the others can execute this file.

bool OthersCanExecute { get; set; }

Property Value

bool

OthersCanRead

Gets or sets a value indicating whether the others can read from this file.

bool OthersCanRead { get; set; }

Property Value

bool

OthersCanWrite

Gets or sets a value indicating whether the others can write into this file.

bool OthersCanWrite { get; set; }

Property Value

bool

OwnerCanExecute

Gets or sets a value indicating whether the owner can execute this file.

bool OwnerCanExecute { get; set; }

Property Value

bool

OwnerCanRead

Gets or sets a value indicating whether the owner can read from this file.

bool OwnerCanRead { get; set; }

Property Value

bool

OwnerCanWrite

Gets or sets a value indicating whether the owner can write into this file.

bool OwnerCanWrite { get; set; }

Property Value

bool

UserId

Gets or sets file user id.

int UserId { get; set; }

Property Value

int

Methods

Delete()

Permanently deletes a file on remote machine.

void Delete()

DeleteAsync(CancellationToken)

Permanently deletes a file on the remote machine.

Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The System.Threading.CancellationToken to observe.

Returns

Task

A System.Threading.Tasks.Task that represents the asynchronous delete operation.

MoveTo(string)

Moves a specified file to a new location on remote machine, providing the option to specify a new file name.

void MoveTo(string destFileName)

Parameters

destFileName string

The path to move the file to, which can specify a different file name.

Exceptions

ArgumentNullException

destFileName is null.

SetPermissions(short)

Sets file permissions.

void SetPermissions(short mode)

Parameters

mode short

The mode.

UpdateStatus()

Updates file status on the server.

void UpdateStatus()