PowerBuilder

SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Http
oleobject loo_Req
integer li_BUseTls
oleobject loo_Resp
oleobject loo_Xml

li_Success = 0

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
loo_Http.Login = "SHAREPOINT_USERNAME"
loo_Http.Password = "SHAREPOINT_PASSWORD"
loo_Http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loo_Http.NtlmAuth = 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.

loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")

loo_Req.HttpVerb = "POST"
loo_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
loo_Req.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

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

// Send the POST using https (TLS). Port 443 is the default port for https.
li_BUseTls = 1
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")

li_Success = loo_Http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,li_BUseTls,loo_Req,loo_Resp)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Req
    destroy loo_Resp
    return
end if

// If failed, the response body contains XML 
loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

loo_Xml.LoadXml(loo_Resp.BodyStr)

if loo_Resp.StatusCode <> 200 then
    Write-Debug "Response status code = " + string(loo_Resp.StatusCode)
    Write-Debug loo_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>
    // 

    Write-Debug "Failed"
    destroy loo_Http
    destroy loo_Req
    destroy loo_Resp
    destroy loo_Xml
    return
end if

// If successful, the response body is empty.
Write-Debug "Success."


destroy loo_Http
destroy loo_Req
destroy loo_Resp
destroy loo_Xml