(PureBasic) SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    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 will delete the file named "penguins2.jpg"
    ;  which is located in the "/Documents" folder.

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

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/_api/web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')")

    ;  We need to add a form digest value in the X-RequestDigest header field.
    ;  See this example for details on
    ;  how to get (and cache) a form digest value
    CkHttpRequest::ckAddHeader(req,"X-RequestDigest","SHAREPOINT_FORM_DIGEST")

    ;  Add additional required headers.
    CkHttpRequest::ckAddHeader(req,"IF-MATCH","*")
    CkHttpRequest::ckAddHeader(req,"X-HTTP-Method","DELETE")

    ;  Send the POST using https (TLS). Port 443 is the default port for https.
    bUseTls.i = 1
    resp.i = CkHttp::ckSynchronousRequest(http,"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    ;  If failed, the response body contains XML
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadXml(xml,CkHttpResponse::ckBodyStr(resp))

    If CkHttpResponse::ckStatusCode(resp) <> 200
        Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug CkXml::ckGetXml(xml)

        ;  For example, if the file did not exist, this would be the XML response:
        ;  <?xml version="1.0" encoding="utf-8" ?>
        ;  <m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
        ;      <m:code>-2146232832, Microsoft.SharePoint.SPException</m:code>
        ;      <m:message xml:lang="en-US">The file /Documents/penguins2.jpg does not exist.</m:message>
        ;  </m:error>
        ; 

        Debug "Failed"
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkXml::ckDispose(xml)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ;  If successful, the response body is empty.
    Debug "Success."


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure