DataFlex

SFTP Get/Set File Permission

See more SFTP Examples

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

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    String sHostname
    Integer iPort
    Boolean iIsHandle
    Boolean iFollowLinks
    Integer iPermVal
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    // Connect to the SSH/SFTP server.  
    Move "sftp.example.com" To sHostname
    Move 22 To iPort
    Get ComConnect Of hoSftp sHostname iPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    Get ComAuthenticatePw Of hoSftp "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // After authenticating, the SFTP subsystem must be initialized:
    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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).
    Move False To iIsHandle
    Move True To iFollowLinks
    Get ComGetFilePermissions Of hoSftp "qa_data/hamlet.xml" iFollowLinks iIsHandle To iPermVal
    If (iPermVal < 0) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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
    Showln "decimal permissions value: " iPermVal

    // 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)
    Get ComSetPermissions Of hoSftp "qa_data/hamlet.xml" iIsHandle 436 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Success."


End_Procedure