(Xojo Plugin) SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http

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

Dim req As New Chilkat.HttpRequest
req.HttpVerb = "POST"
req.Path = "/_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
req.AddHeader "X-RequestDigest","SHAREPOINT_FORM_DIGEST"

//  Add additional required headers.
req.AddHeader "IF-MATCH","*"
req.AddHeader "X-HTTP-Method","DELETE"

//  Send the POST using https (TLS). Port 443 is the default port for https.
Dim bUseTls As Boolean
bUseTls = True
Dim resp As Chilkat.HttpResponse
resp = http.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req)
If (http.LastMethodSuccess <> True) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

//  If failed, the response body contains XML
Dim xml As New Chilkat.Xml
success = xml.LoadXml(resp.BodyStr)

If (resp.StatusCode <> 200) Then
    System.DebugLog("Response status code = " + Str(resp.StatusCode))
    System.DebugLog(xml.GetXml())

    //  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>
    // 

    System.DebugLog("Failed")

    Return
End If

//  If successful, the response body is empty.
System.DebugLog("Success.")