Unicode C

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.

Unicode C

#include <C_CkHttpW.h>
#include <C_CkHttpRequestW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkXmlW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttpW http;
    HCkHttpRequestW req;
    BOOL bUseTls;
    HCkHttpResponseW resp;
    HCkXmlW xml;

    success = FALSE;

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

    http = CkHttpW_Create();

    //  If SharePoint Windows classic authentication is used, then set the 
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttpW_putLogin(http,L"SHAREPOINT_USERNAME");
    CkHttpW_putPassword(http,L"SHAREPOINT_PASSWORD");
    CkHttpW_putLoginDomain(http,L"SHAREPOINT_NTLM_DOMAIN");
    CkHttpW_putNtlmAuth(http,TRUE);

    //  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.

    req = CkHttpRequestW_Create();
    CkHttpRequestW_putHttpVerb(req,L"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.
    CkHttpRequestW_putPath(req,L"/_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
    CkHttpRequestW_AddHeader(req,L"X-RequestDigest",L"SHAREPOINT_FORM_DIGEST");

    //  Send the POST using HTTPS (TLS). Port 443 is the default port for https.
    bUseTls = TRUE;
    resp = CkHttpResponseW_Create();
    success = CkHttpW_HttpSReq(http,L"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkHttpRequestW_Dispose(req);
        CkHttpResponseW_Dispose(resp);
        return;
    }

    //  The response body contains XML.
    xml = CkXmlW_Create();
    CkXmlW_LoadXml(xml,CkHttpResponseW_bodyStr(resp));

    if (CkHttpResponseW_getStatusCode(resp) != 200) {
        wprintf(L"Response status code = %d\n",CkHttpResponseW_getStatusCode(resp));
        wprintf(L"%s\n",CkXmlW_getXml(xml));
        wprintf(L"Failed\n");
        CkHttpW_Dispose(http);
        CkHttpRequestW_Dispose(req);
        CkHttpResponseW_Dispose(resp);
        CkXmlW_Dispose(xml);
        return;
    }

    //  Show the successful XML response.
    wprintf(L"%s\n",CkXmlW_getXml(xml));
    wprintf(L"Success.\n");

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


    CkHttpW_Dispose(http);
    CkHttpRequestW_Dispose(req);
    CkHttpResponseW_Dispose(resp);
    CkXmlW_Dispose(xml);

    }