(PureBasic) 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.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkBinData.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; If SharePoint Windows classic authentication is used, then set the 
    ; Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttp::setCkLogin(http, "SHAREPOINT_USERNAME")
    CkHttp::setCkPassword(http, "SHAREPOINT_PASSWORD")
    CkHttp::setCkLoginDomain(http, "SHAREPOINT_NTLM_DOMAIN")
    CkHttp::setCkNtlmAuth(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.

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

    CkHttp::setCkAcceptCharset(http, "utf-8")

    strCsv.s = CkHttp::ckQuickGetStr(http,url)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

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

    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkHttp::ckQuickGetBd(http,url,bd)
    If success <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkBinData::ckDispose(bd)
        ProcedureReturn
    EndIf

    ; Interpret the bytes correctly as utf-8
    sb.i = CkStringBuilder::ckCreate()
    If sb.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppendBd(sb,bd,"utf-8",0,0)
    Debug "CSV:"
    Debug CkStringBuilder::ckGetAsString(sb)


    CkHttp::ckDispose(http)
    CkBinData::ckDispose(bd)
    CkStringBuilder::ckDispose(sb)


    ProcedureReturn
EndProcedure