Tcl

SharePoint -- Download a Text File into a String Variable

See more SharePoint Examples

Demonstrates how to download a text file from SharePoint into a string variable. Tcl

load ./chilkat.dll

set success 0

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# -------------------------------------------------------------------------
# The following comments apply to SharePoint Windows classic authentication.
# -------------------------------------------------------------------------
# For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
# The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
# The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
# Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
# for example, "chilkat" instead of "chilkat@mycompany.com"

set http [new_CkHttp]

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_put_Login $http "SHAREPOINT_USERNAME"
CkHttp_put_Password $http "SHAREPOINT_PASSWORD"
CkHttp_put_LoginDomain $http "SHAREPOINT_NTLM_DOMAIN"
CkHttp_put_NtlmAuth $http 1

# -------------------------------------------------------------------------
# The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
# If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
# establish the cookie as shown at SharePoint Online Authentication
# -------------------------------------------------------------------------

# This example downloads a CSV file that is utf-8 and contains Japanese characters.

set url "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/ChilkatTest/japanese.csv')/$value"

CkHttp_put_AcceptCharset $http "utf-8"

set strCsv [CkHttp_quickGetStr $http $url]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

# The CSV file is contained in strCsv.
puts "CSV:"
puts "$strCsv"

# Note: The HTTP response hopefully indicates the charset of the response,
# and Chilkat should receive the string correctly.  If the response sent by
# SharePoint does not indicate a charset, or indicates an incorrect charset,
# then we can instead download the text file as binary data and interpret the
# bytes ourselves correctly.  For example:  

set bd [new_CkBinData]

set success [CkHttp_QuickGetBd $http $url $bd]
if {$success != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkBinData $bd
    exit
}

# Interpret the bytes correctly as utf-8
set sb [new_CkStringBuilder]

CkStringBuilder_AppendBd $sb $bd "utf-8" 0 0
puts "CSV:"
puts [CkStringBuilder_getAsString $sb]

delete_CkHttp $http
delete_CkBinData $bd
delete_CkStringBuilder $sb