Visual FoxPro

SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file. Visual FoxPro

LOCAL lnSuccess
LOCAL loHttp
LOCAL loReq
LOCAL lnBUseTls
LOCAL loResp
LOCAL loXml

lnSuccess = 0

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

loHttp = CreateObject('Chilkat.Http')

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

loReq = CreateObject('Chilkat.HttpRequest')
loReq.HttpVerb = "POST"
loReq.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
loReq.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

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

*  Send the POST using https (TLS). Port 443 is the default port for https.
lnBUseTls = 1
loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,lnBUseTls,loReq,loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loResp
    CANCEL
ENDIF

*  If failed, the response body contains XML 
loXml = CreateObject('Chilkat.Xml')
loXml.LoadXml(loResp.BodyStr)

IF (loResp.StatusCode <> 200) THEN
    ? "Response status code = " + STR(loResp.StatusCode)
    ? loXml.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>
    *  

    ? "Failed"
    RELEASE loHttp
    RELEASE loReq
    RELEASE loResp
    RELEASE loXml
    CANCEL
ENDIF

*  If successful, the response body is empty.
? "Success."

RELEASE loHttp
RELEASE loReq
RELEASE loResp
RELEASE loXml