Tcl

SharePoint -- Check Out a File (or Undo a Checkout)

In SharePoint, you can check out a file to make sure nobody can change it before you update it. After updating, you can check in the file. This example shows how to check out a SharePoint file.

Note: To undo a checkout, replace the string "checkout" with "undocheckout" in the line of code that sets the request's path.

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

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

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
# Note that our path uses GetFileByServerRelativeUrl and not GetFolderByServerRelativeUrl
# Also, if your Sharepoint site is within a site collection, the URL is formatted like this (where "teamA" is the name of the site)
# /sites/teamA/_api/web/GetFileByServerRelativeUrl('/sites/teamA/Documents/penguins2.jpg')/checkout

# Note: To undo a checkout, replace "checkout" with "undocheckout" in the following line of code.
CkHttpRequest_put_Path $req "/_api/web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')/checkout"

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

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

# 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]
    puts "Failed"
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    delete_CkXml $xml
    exit
}

# Show the successful XML response.
puts [CkXml_getXml $xml]
puts "Success."

# A successful XML response looks like this:
# <?xml version="1.0" encoding="utf-8" ?>
# <d:CheckOut xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" 
# 	xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
# 	xmlns:georss="http://www.georss.org/georss" 
# 	xmlns:gml="http://www.opengis.net/gml" m:null="true" />
# 
# 

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