(PureBasic) Download a Text File into a String

Downloads a text file to a string variable.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAzureStorage.pb"

Procedure ChilkatExample()

    ; Azure File Service Example: Download Text File into String
    ; See:  https://docs.microsoft.com/en-us/rest/api/storageservices/get-file

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

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

    ; Connect to the Azure Storage Blob Service
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; In this example, the storage account name is "chilkat".
    success.i = CkRest::ckConnect(rest,"chilkat.file.core.windows.net",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide Azure Cloud credentials for the REST calls.
    azAuth.i = CkAuthAzureStorage::ckCreate()
    If azAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAzureStorage::setCkAccessKey(azAuth, "AZURE_ACCESS_KEY")
    ; The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    CkAuthAzureStorage::setCkAccount(azAuth, "chilkat")
    CkAuthAzureStorage::setCkScheme(azAuth, "SharedKey")
    CkAuthAzureStorage::setCkService(azAuth, "File")
    ; This causes the "x-ms-version: 2020-08-04" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2020-08-04")
    success = CkRest::ckSetAuthAzureStorage(rest,azAuth)

    ; Note: The application does not need to explicitly set the following
    ; headers: x-ms-date, Authorization.  These headers
    ; are automatically set by Chilkat.

    ; Send a GET request to download the file "hamlet.xml" to a StringBuilder object.
    ; (The share name is "pip")
    sbFileContents.i = CkStringBuilder::ckCreate()
    If sbFileContents.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/pip/xmlFiles/hamlet.xml",sbFileContents)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStringBuilder::ckDispose(sbFileContents)
        ProcedureReturn
    EndIf

    ; When successful, the response status will be 200.
    ; If a non-success status code is returned, then the sbFileContents actually contains the XML error message.
    If CkRest::ckResponseStatusCode(rest) <> 200
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + CkStringBuilder::ckGetAsString(sbFileContents)
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStringBuilder::ckDispose(sbFileContents)
        ProcedureReturn
    EndIf

    Debug "Length of downloaded string = " + Str(CkStringBuilder::ckLength(sbFileContents))

    strFileContents.s = CkStringBuilder::ckGetAsString(sbFileContents)
    Debug strFileContents

    CkStringBuilder::ckWriteFile(sbFileContents,"qa_output/hamlet.xml","utf-8",0)


    CkRest::ckDispose(rest)
    CkAuthAzureStorage::ckDispose(azAuth)
    CkStringBuilder::ckDispose(sbFileContents)


    ProcedureReturn
EndProcedure