Unicode C
Unicode C
SharePoint -- Get File Metadata (File Size, Last-Modified Date/Time, etc.)
See more SharePoint Examples
Demonstrates how to get a file's metdata, which includes the file size, last-modified date/time, name, server relative URL, etc.Chilkat Unicode C Downloads
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkDateTimeW.h>
#include <C_CkDtObjW.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttpW http;
const wchar_t *url;
const wchar_t *jsonReply;
HCkJsonObjectW json;
int fileSize;
HCkDateTimeW lastmod;
BOOL bLocalTime;
int unixTime;
HCkDtObjW dtObj;
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
// Indicate that we want a JSON reply
CkHttpW_putAccept(http,L"application/json;odata=verbose");
CkHttpW_putAcceptCharset(http,L"utf-8");
url = L"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')";
jsonReply = CkHttpW_quickGetStr(http,url);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
return;
}
// Examine the file's metadata in JSON format.
json = CkJsonObjectW_Create();
CkJsonObjectW_Load(json,jsonReply);
CkJsonObjectW_putEmitCompact(json,FALSE);
// Make sure it was a success response, and that we really have metadata.
// If it was an error response, then the JSON is error information..
if (CkHttpW_getLastStatus(http) != 200) {
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"--------\n");
wprintf(L"Server relative URL: %s\n",CkJsonObjectW_stringOf(json,L"d.ServerRelativeUrl"));
fileSize = CkJsonObjectW_IntOf(json,L"d.Length");
wprintf(L"File Size = %d\n",fileSize);
lastmod = CkDateTimeW_Create();
CkDateTimeW_SetFromTimestamp(lastmod,CkJsonObjectW_stringOf(json,L"d.TimeLastModified"));
// Once we have the CkDateTime object, we can get the date/time in all sorts of formats:
// Get as a RFC822 GMT string:
bLocalTime = FALSE;
wprintf(L"%s\n",CkDateTimeW_getAsRfc822(lastmod,bLocalTime));
// Get as an RFC822 string in the local timezone.
// (remember, the daylight savings that existed at the given time in the past is applied)
bLocalTime = TRUE;
wprintf(L"%s\n",CkDateTimeW_getAsRfc822(lastmod,bLocalTime));
// Get as a 32-bit UNIX time (local or GMT..)
// The Unix time is number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
unixTime = CkDateTimeW_GetAsUnixTime(lastmod,bLocalTime);
wprintf(L"Unix time: %d\n",unixTime);
// One can also get the as a "DtObj" object for accessing the individual
// parts of the date/time, such as month, day, year, hour, minute, etc.
// The DtObj can be obtained in the GMT or local timezone:
dtObj = CkDtObjW_Create();
CkDateTimeW_ToDtObj(lastmod,bLocalTime,dtObj);
if (CkDateTimeW_getLastMethodSuccess(lastmod) == FALSE) {
wprintf(L"This should never really happen!\n");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkDateTimeW_Dispose(lastmod);
CkDtObjW_Dispose(dtObj);
return;
}
wprintf(L"%d-%d-%d %d:%d:%d\n",CkDtObjW_getDay(dtObj),CkDtObjW_getMonth(dtObj),CkDtObjW_getYear(dtObj),CkDtObjW_getHour(dtObj),CkDtObjW_getMinute(dtObj),CkDtObjW_getSecond(dtObj));
// -------------------------------------------------
// The file's metadata look like this:
// {
// "d": {
// "__metadata": {
// "id": "Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
// "type": "SP.File"
// },
// "Author": {
// "__deferred": {
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Author"
// }
// },
// "CheckedOutByUser": {
// "__deferred": {
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/CheckedOutByUser"
// }
// },
// "ListItemAllFields": {
// "__deferred": {
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ListItemAllFields"
// }
// },
// "LockedByUser": {
// "__deferred": {
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/LockedByUser"
// }
// },
// "ModifiedBy": {
// "__deferred": {
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ModifiedBy"
// }
// },
// "Versions": {
// "__deferred": {
// "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Versions"
// }
// },
// "CheckInComment": "",
// "CheckOutType": 2,
// "ContentTag": "{E2F05E75-B3EF-4826-8284-E572D3628A7D},9,10",
// "CustomizedPageStatus": 0,
// "ETag": "\"{E2F05E75-B3EF-4826-8284-E572D3628A7D},9\"",
// "Exists": true,
// "Length": "21082",
// "Level": 2,
// "MajorVersion": 0,
// "MinorVersion": 3,
// "Name": "VCAC-document.docx",
// "ServerRelativeUrl": "/Documents/VCAC-document.docx",
// "TimeCreated": "2016-03-04T12:38:01Z",
// "TimeLastModified": "2017-01-16T04:44:31Z",
// "Title": "",
// "UIVersion": 3,
// "UIVersionLabel": "0.3"
// }
// }
//
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkDateTimeW_Dispose(lastmod);
CkDtObjW_Dispose(dtObj);
}