PureBasic

Download a Binary File into Memory

See more Azure Cloud Storage Examples

Downloads a binary file into memory. PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ; Azure File Service Example: Download a Binary File to Memory
    ; 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 = CkRest::ckConnect(rest,"chilkat.file.core.windows.net",port,bTls,bAutoReconnect)
    If success = 0
        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: 2021-08-06" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2021-08-06")
    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 "penguins.jpg" to a BinData object.
    ; (The share name is "pip")
    bdFileContents.i = CkBinData::ckCreate()
    If bdFileContents.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodyBd(rest,"GET","/pip/wildlife/antarctic/penguins.jpg",bdFileContents)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkBinData::ckDispose(bdFileContents)
        ProcedureReturn
    EndIf

    ; When successful, the response status will be 200.
    ; If a non-success status code is returned, then the bdFileContents 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)
        sbXmlErr.i = CkStringBuilder::ckCreate()
        If sbXmlErr.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        CkStringBuilder::ckAppendBd(sbXmlErr,bdFileContents,"utf-8",0,0)
        Debug "response body (if any): " + CkStringBuilder::ckGetAsString(sbXmlErr)
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkBinData::ckDispose(bdFileContents)
        CkStringBuilder::ckDispose(sbXmlErr)
        ProcedureReturn
    EndIf

    Debug "Size of the downloaded file = " + Str(CkBinData::ckNumBytes(bdFileContents))

    ; See the online reference documentation for the BinData class for ways
    ; to access the bytes.

    CkBinData::ckWriteFile(bdFileContents,"qa_output/penguins.jpg")


    CkRest::ckDispose(rest)
    CkAuthAzureStorage::ckDispose(azAuth)
    CkBinData::ckDispose(bdFileContents)
    CkStringBuilder::ckDispose(sbXmlErr)


    ProcedureReturn
EndProcedure