Classic ASP

Detect End-of-File on a Remote SFTP File

Demonstrates the Chilkat SFtp.Eof method, which returns whether the most recent read for a handle received the SFTP end-of-file status. The only argument is the handle. This example reads until Eof is true.

Background: The timing here is worth understanding: reading exactly through the final byte does not immediately set EOF. The next read succeeds, returns zero bytes, sets the status to SSH_FX_EOF, and only then does Eof report true. That is why the loop tests Eof after each read rather than assuming a short read means the end — a short read can also just be the server returning less than requested.

Chilkat Classic ASP Downloads

Download Chilkat for Classic ASP

Classic ASP

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
success = 0

'  Demonstrates the SFtp.Eof method, which returns whether the most recent read for a handle
'  received the SFTP end-of-file status.  The only argument is the handle.

set sftp = Server.CreateObject("Chilkat.SFtp")

'  Connect, authenticate, and initialize the SFTP subsystem.
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( sftp.LastErrorText) & "</pre>"
    Response.End
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.
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( sftp.LastErrorText) & "</pre>"
    Response.End
End If

success = sftp.InitializeSftp()
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( sftp.LastErrorText) & "</pre>"
    Response.End
End If

handle = sftp.OpenFile("subdir/data.txt","readOnly","openExisting")
If (sftp.LastMethodSuccess = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( sftp.LastErrorText) & "</pre>"
    Response.End
End If

'  Read until Eof reports the end of the file.  Note that reading exactly through the final byte
'  does not set EOF; the next read returns zero bytes and then Eof becomes true.
set sbContent = Server.CreateObject("Chilkat.StringBuilder")
chunkSize = 4096
reading = 1
Do While reading
    chunk = sftp.ReadFileText(handle,chunkSize,"utf-8")
    If (sftp.LastReadFailed(handle)) Then
        Response.Write "<pre>" & Server.HTMLEncode( sftp.LastErrorText) & "</pre>"
        Response.End
    End If

    success = sbContent.Append(chunk)
    reading = Not sftp.Eof(handle)
Loop

success = sftp.CloseHandle(handle)
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( sftp.LastErrorText) & "</pre>"
    Response.End
End If

Response.Write "<pre>" & Server.HTMLEncode( sbContent.GetAsString()) & "</pre>"

sftp.Disconnect 

%>
</body>
</html>