(Excel) SharePoint -- Download a Text File into a String Variable

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

Download Excel Class Modules Chilkat Excel Class Modules

'  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"

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

'  If SharePoint Windows classic authentication is used, then set the
'  Login, Password, LoginDomain, and NtlmAuth properties.
http.Login = "SHAREPOINT_USERNAME"
http.Password = "SHAREPOINT_PASSWORD"
http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
http.NtlmAuth = True

'  -------------------------------------------------------------------------
'  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.


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


strCsv = http.QuickGetStr(url)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

'  The CSV file is contained in strCsv.
Debug.Print "CSV:"
Debug.Print 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:

Dim bd As Chilkat.BinData
Set bd = Chilkat.NewBinData

success = http.QuickGetBd(url,bd)
If (success <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

'  Interpret the bytes correctly as utf-8
Dim sb As Chilkat.StringBuilder
Set sb = Chilkat.NewStringBuilder
success = sb.AppendBd(bd,"utf-8",0,0)
Debug.Print "CSV:"
Debug.Print sb.GetAsString()