Syntax
| SFTP.SetPermissions(pathOrHandle As String, ByVal isHandle As Long, ByVal permissions As Long) As Long
|
|---|---|
Description
| Sets the permissions for a file on the server. The pathOrHandle may be a filepath or the handle of a currently open file. isHandle should be set to 1 if the pathOrHandle is a handle, otherwise set isHandle to 0.
Returns 1 for success, 0 for failure.
|
See Also
| |
Example
| Sub Main
' Connect to the SSH/SFTP server.
Dim hostname As String
hostname = "sftp.example.com"
Dim port As Long
port = 22
Dim success As Long
success = sftp.Connect(hostname,port)
If (success <> 1) Then
Debug.Print 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 <> 1) Then
Debug.Print sftp.LastErrorText
Exit Sub
End If
' After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
If (success <> 1) Then
Debug.Print 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 Long
isHandle = 0
Dim followLinks As Long
followLinks = 1
Dim permVal As Long
permVal = sftp.GetFilePermissions("qa_data/hamlet.xml",followLinks,isHandle)
If (permVal < 0) Then
Debug.Print 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.Print "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 <> 1) Then
Debug.Print sftp.LastErrorText
Exit Sub
End If
Debug.Print "Success."
End Sub
|