Get a Remote File's POSIX Permissions

See more SFTP Examples

Demonstrates the Chilkat SFtp.GetFilePermissions method, which returns a remote item's complete POSIX mode value. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Dim success As Boolean
success = False

//  Demonstrates the SFtp.GetFilePermissions method, which returns a remote item's complete POSIX
//  mode value.  The 1st argument is the remote path (or handle), the 2nd selects whether symbolic
//  links are followed, and the 3rd indicates whether the 1st argument is a handle.

Dim sftp As New Chilkat.SFtp

//  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
//  The 3rd argument (bIsHandle) is 0 here because the 1st argument is a path, not an
//  open handle.
Dim bFollowLinks As Boolean
bFollowLinks = True
Dim bIsHandle As Boolean
bIsHandle = False

Dim mode As Int32
mode = sftp.GetFilePermissions("subdir/script.sh",bFollowLinks,bIsHandle)
If (mode < 0) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  The value is the complete POSIX mode, which combines the file-type bits with the
//  owner/group/other permission bits (the low 9 bits).  For example, a mode of 33261 (octal
//  0100755) is a regular file with 0755 permissions.
System.DebugLog("POSIX mode (decimal): " + Str(mode))

sftp.Disconnect