PowerBuilder

SFTP Get/Set File Permission

See more SFTP Examples

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

integer li_rc
integer li_Success
oleobject loo_Sftp
string ls_Hostname
integer li_Port
integer li_IsHandle
integer li_FollowLinks
integer li_PermVal

li_Success = 0

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

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to the SSH/SFTP server.  
ls_Hostname = "sftp.example.com"
li_Port = 22
li_Success = loo_Sftp.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
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.
li_Success = loo_Sftp.AuthenticatePw("myLogin","myPassword")
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

// After authenticating, the SFTP subsystem must be initialized:
li_Success = loo_Sftp.InitializeSftp()
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
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).
li_IsHandle = 0
li_FollowLinks = 1
li_PermVal = loo_Sftp.GetFilePermissions("qa_data/hamlet.xml",li_FollowLinks,li_IsHandle)
if li_PermVal < 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
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
Write-Debug "decimal permissions value: " + string(li_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)
li_Success = loo_Sftp.SetPermissions("qa_data/hamlet.xml",li_IsHandle,436)
if li_Success <> 1 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "Success."


destroy loo_Sftp