Xbase++

SFTP Get/Set File Permission

See more SFTP Examples

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

LOCAL nSuccess
LOCAL oSftp
LOCAL cHostname
LOCAL nPort
LOCAL nIsHandle
LOCAL nFollowLinks
LOCAL nPermVal

nSuccess := 0

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

oSftp := CreateObject("Chilkat.SFtp")

//  Connect to the SSH/SFTP server.  
cHostname := "sftp.example.com"
nPort := 22
nSuccess := oSftp:Connect(cHostname, nPort)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Authenticate with the SSH server.  Chilkat SFTP supports
//  both password-based authenication as well as public-key
//  authentication.  This example uses password authenication.
nSuccess := oSftp:AuthenticatePw("myLogin", "myPassword")
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  After authenticating, the SFTP subsystem must be initialized:
nSuccess := oSftp:InitializeSftp()
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  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).
nIsHandle := 0
nFollowLinks := 1
nPermVal := oSftp:GetFilePermissions("qa_data/hamlet.xml", nFollowLinks, nIsHandle)
IF (nPermVal < 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  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
? "decimal permissions value: " + Str(nPermVal)

//  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)
nSuccess := oSftp:SetPermissions("qa_data/hamlet.xml", nIsHandle, 436)
IF (nSuccess != 1)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "Success."

oSftp:destroy()