Tcl

SharePoint -- Delete a Folder

Demonstrates how to delete a SharePoint folder. 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 folder /Documents/ChilkatTest2

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
# If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents/ChilkatTest2')" where "teamA" is the name of the site.
CkHttpRequest_put_Path $req "/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest2')"

# 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]

# Note: It seems that if an attempt is made to delete a folder that does not exist,
# the response status code is 200, indicating success.
if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts [CkXml_getXml $xml]
    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