Unicode C
Unicode C
Download a File from a SharePoint Documents Library
See more SharePoint Examples
This example shows how to use Chilkat's HttpCurl class to download a file from the root of a SharePoint Documents document library. The example demonstrates how HttpCurl automatically resolves the SharePoint site name to a site ID, finds the drive ID for the Documents library, locates the file by name, and then downloads the file content using Microsoft Graph.
Chilkat Unicode C Downloads
#include <C_CkJsonObjectW.h>
#include <C_CkHttpCurlW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObjectW jsonAuth;
HCkHttpCurlW curl;
const wchar_t *curlCommand;
int statusCode;
HCkStringBuilderW sbFileContents;
success = FALSE;
// This example downloads a file named "hamlet.json" from the root of the SharePoint
// Documents document library.
//
// The example demonstrates how HttpCurl can automatically resolve all of the
// information needed to locate and download a file:
//
// site_name -> site_id
// site_id -> document_library_id
// document_library_id -> file_id
// file_id -> file content
//
// The application only provides the SharePoint site name and the desired
// filename. HttpCurl automatically executes the required Microsoft Graph
// requests to obtain the remaining values.
success = FALSE;
// --------------------------------------------------------------------------------------------------------
// Before running this example, create an Azure App Registration and grant it
// the Microsoft Graph permissions required to access SharePoint.
//
// The application will authenticate using OAuth2 Client Credentials.
// See:
// How to Create SharePoint App Registration for OAuth 2.0 Client Credentials
// --------------------------------------------------------------------------------------------------------
// Build a JSON authentication configuration.
// HttpCurl will use this information to automatically obtain OAuth2 access tokens.
jsonAuth = CkJsonObjectW_Create();
// Enable secret lookup.
//
// Instead of hard-coding sensitive values such as the client ID,
// client secret, and token endpoint, secret specification strings
// are used. Chilkat automatically retrieves the actual values from
// Windows Credential Manager (Windows) or Apple Keychain (macOS).
//
// See:
// Secret Specification Strings
CkJsonObjectW_putEnableSecrets(jsonAuth,TRUE);
success = CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.client_id",L"!!sharepoint|oauth2|client_id");
if (success == TRUE) {
success = CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.client_secret",L"!!sharepoint|oauth2|client_secret");
}
if (success == TRUE) {
success = CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.token_endpoint",L"!!sharepoint|oauth2|token_endpoint");
}
if (success == FALSE) {
wprintf(L"%s\n",CkJsonObjectW_lastErrorText(jsonAuth));
CkJsonObjectW_Dispose(jsonAuth);
return;
}
// Request Microsoft Graph permissions that were granted to the application.
CkJsonObjectW_UpdateString(jsonAuth,L"oauth2.scope",L"https://graph.microsoft.com/.default");
// ---------------------------------------------------------------------------------------------------
curl = CkHttpCurlW_Create();
// Associate the OAuth2 configuration with HttpCurl.
//
// When the request is executed, Chilkat automatically obtains an access token
// if needed and adds the Authorization: Bearer header to the HTTP request.
CkHttpCurlW_SetAuth(curl,jsonAuth);
// Define values that are already known.
//
// These variables are referenced in curl commands using
// {{variable_name}} substitution syntax.
CkHttpCurlW_SetVar(curl,L"sharepoint_hostname",L"example.sharepoint.com");
CkHttpCurlW_SetVar(curl,L"site_name",L"test");
// The first step is to obtain the Microsoft Graph site ID.
//
// The application only knows the SharePoint site name, so define
// a function that can retrieve the site information.
CkHttpCurlW_AddFunction(curl,L"getSite",L"GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}");
// Extract the site's ID and store it in the HttpCurl variable named site_id.
CkHttpCurlW_AddOutput(curl,L"getSite",L"id",L"site_id");
// The next step is to find the Documents document library.
//
// Microsoft Graph refers to document libraries as "drives".
CkHttpCurlW_AddFunction(curl,L"getDrives",L"GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives");
// Search the returned drives for the one named "Documents"
// and save its drive ID in the document_library_id variable.
CkHttpCurlW_AddOutput2(curl,L"getDrives",L"value",L"name",L"Documents",TRUE,L"id",L"document_library_id");
// Now list the contents of the Documents document library.
CkHttpCurlW_AddFunction(curl,L"getFiles",L"GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives/{{document_library_id}}/root/children");
// Search the returned files for an item named "hamlet.json"
// and save its Microsoft Graph item ID in the file_id variable.
CkHttpCurlW_AddOutput2(curl,L"getFiles",L"value",L"name",L"hamlet.json",TRUE,L"id",L"file_id");
// This is the target request.
//
// GET -L https://graph.microsoft.com/v1.0/drives/{{document_library_id}}/items/{{file_id}}/content
//
// The /content endpoint returns the actual contents of the file.
//
// The -L option instructs HttpCurl to follow the redirect returned by
// Microsoft Graph. The Graph API typically responds with a redirect
// to the actual file download URL.
curlCommand = L"GET -L https://graph.microsoft.com/v1.0/drives/{{document_library_id}}/items/{{file_id}}/content";
// Execute the request.
//
// HttpCurl examines the target request and determines that both
// document_library_id and file_id are required.
//
// To obtain these values, it automatically builds and executes
// the following dependency chain:
//
// 1) getSite -> site_id
// 2) getDrives -> document_library_id
// 3) getFiles -> file_id
// 4) download -> file content
//
// The final response returned by DoYourThing is the downloaded
// file content from the target request.
success = CkHttpCurlW_DoYourThing(curl,curlCommand);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpCurlW_lastErrorText(curl));
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
return;
}
// A successful Graph response should return HTTP 200.
// Any other status code typically indicates an authentication,
// permission, site lookup, document library lookup, or file lookup error.
statusCode = CkHttpCurlW_getStatusCode(curl);
if (statusCode != 200) {
wprintf(L"%s\n",CkHttpCurlW_responseBodyStr(curl));
wprintf(L"status code = %d\n",statusCode);
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
return;
}
// The response body contains the contents of the downloaded file.
sbFileContents = CkStringBuilderW_Create();
CkHttpCurlW_GetResponseSb(curl,sbFileContents);
// Optionally save the downloaded content to a local file.
//
// The third argument controls whether the file is appended.
// Passing ckfalse causes the file to be overwritten if it already exists.
success = CkStringBuilderW_WriteFile(sbFileContents,L"c:/temp/hamlet.json",L"utf-8",FALSE);
if (success == FALSE) {
wprintf(L"%s\n",CkStringBuilderW_lastErrorText(sbFileContents));
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
CkStringBuilderW_Dispose(sbFileContents);
return;
}
wprintf(L"Success.\n");
CkJsonObjectW_Dispose(jsonAuth);
CkHttpCurlW_Dispose(curl);
CkStringBuilderW_Dispose(sbFileContents);
}