VB.NET

SFTP Get/Set File Permission

See more SFTP Examples

Demonstrates how to set the permissions of a file on the SFTP server. VB.NET

Dim success As Boolean = False

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim sftp As New Chilkat.SFtp

' Connect to the SSH/SFTP server.  
Dim hostname As String = "sftp.example.com"
Dim port As Integer = 22
success = sftp.Connect(hostname,port)
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Authenticate with the SSH server.  Chilkat SFTP supports
' both password-based authenication as well as public-key
' authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Get the file permissions for the "hamlet.xml" file on the server.
' The hamlet.xml file is located in the qa_data directory found under the HOME directory of the SSH user account.
' We are passing the remote file path (we are not passing a file handle returned by a previous call to OpenFile).
Dim isHandle As Boolean = False
Dim followLinks As Boolean = True
Dim permVal As Integer = sftp.GetFilePermissions("qa_data/hamlet.xml",followLinks,isHandle)
If (permVal < 0) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


' Note: Filesystem permissions on Linux/Unix/MacOSX are typically written in octal (POSIX file permissions).  For example 0644 is octal.
' To convert to decimal: octal 644 = 6*8^2 + 4*8 + 4 = 420 (decimal)
' 
' The server may return a permissions value (in octal) such as 100644.
' The "100" indicates the file type, such as regular file or directory. 

' Show the decimal value of the permissions
Debug.WriteLine("decimal permissions value: " & permVal)

' To set the file permissions, pass the integer value.
' Let's change the permissions to 0664, which is 6*8^2 + 6*8 + 4 = 436 (decimal)
success = sftp.SetPermissions("qa_data/hamlet.xml",isHandle,436)
If (success <> True) Then
    Debug.WriteLine(sftp.LastErrorText)
    Exit Sub
End If


Debug.WriteLine("Success.")