Xojo Plugin

Get a Remote File's Owner

Demonstrates the Chilkat SFtp.GetFileOwner method, which returns a remote file's owner. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: Ownership determines who may read, write, or change a file under Unix permission rules, so reading the owner is useful for auditing or for deciding whether an operation will be allowed. Note that a server may report the owner as a numeric UID rather than a name if it cannot resolve the account, and that ownership is a Unix concept — servers on other platforms may return an empty or synthetic value.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SFtp.GetFileOwner method, which returns a remote file's owner.  The 1st
//  argument is the remote path (or handle), the 2nd selects whether symbolic links are followed,
//  and the 3rd indicates whether the 1st argument is a handle.

Dim sftp As New Chilkat.SFtp

//  Connect, authenticate, and initialize the SFTP subsystem.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
//  The 3rd argument (bIsHandle) is 0 here because the 1st argument is a path, not an
//  open handle.
Dim bFollowLinks As Boolean
bFollowLinks = True
Dim bIsHandle As Boolean
bIsHandle = False

Dim owner As String
owner = sftp.GetFileOwner("subdir/report.pdf",bFollowLinks,bIsHandle)
If (sftp.LastMethodSuccess = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("Owner: " + owner)

sftp.Disconnect