Tcl

SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file. Tcl

load ./chilkat.dll

set success 0

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

set http [new_CkHttp]

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_put_Login $http "SHAREPOINT_USERNAME"
CkHttp_put_Password $http "SHAREPOINT_PASSWORD"
CkHttp_put_LoginDomain $http "SHAREPOINT_NTLM_DOMAIN"
CkHttp_put_NtlmAuth $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.

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $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_AddHeader $req "X-RequestDigest" "SHAREPOINT_FORM_DIGEST"

# Add additional required headers.
CkHttpRequest_AddHeader $req "IF-MATCH" "*"
CkHttpRequest_AddHeader $req "X-HTTP-Method" "DELETE"

# Send the POST using https (TLS). Port 443 is the default port for https.
set bUseTls 1
set resp [new_CkHttpResponse]

set success [CkHttp_HttpSReq $http "SHAREPOINT_HTTPS_DOMAIN" 443 $bUseTls $req $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    exit
}

# If failed, the response body contains XML 
set xml [new_CkXml]

CkXml_LoadXml $xml [CkHttpResponse_bodyStr $resp]

if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts [CkXml_getXml $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>
    # 

    puts "Failed"
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    delete_CkXml $xml
    exit
}

# If successful, the response body is empty.
puts "Success."

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkHttpResponse $resp
delete_CkXml $xml