C
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 C Downloads
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkDateTime.h>
#include <C_CkDtObj.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttp http;
const char *url;
const char *jsonReply;
HCkJsonObject json;
int fileSize;
HCkDateTime lastmod;
BOOL bLocalTime;
int unixTime;
HCkDtObj dtObj;
success = FALSE;
// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// If SharePoint Windows classic authentication is used, then set the
// Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_putLogin(http,"SHAREPOINT_USERNAME");
CkHttp_putPassword(http,"SHAREPOINT_PASSWORD");
CkHttp_putLoginDomain(http,"SHAREPOINT_NTLM_DOMAIN");
CkHttp_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
CkHttp_putAccept(http,"application/json;odata=verbose");
CkHttp_putAcceptCharset(http,"utf-8");
url = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')";
jsonReply = CkHttp_quickGetStr(http,url);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
return;
}
// Examine the file's metadata in JSON format.
json = CkJsonObject_Create();
CkJsonObject_Load(json,jsonReply);
CkJsonObject_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 (CkHttp_getLastStatus(http) != 200) {
printf("%s\n",CkJsonObject_emit(json));
printf("Failed.\n");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
return;
}
printf("%s\n",CkJsonObject_emit(json));
printf("--------\n");
printf("Server relative URL: %s\n",CkJsonObject_stringOf(json,"d.ServerRelativeUrl"));
fileSize = CkJsonObject_IntOf(json,"d.Length");
printf("File Size = %d\n",fileSize);
lastmod = CkDateTime_Create();
CkDateTime_SetFromTimestamp(lastmod,CkJsonObject_stringOf(json,"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;
printf("%s\n",CkDateTime_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;
printf("%s\n",CkDateTime_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 = CkDateTime_GetAsUnixTime(lastmod,bLocalTime);
printf("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 = CkDtObj_Create();
CkDateTime_ToDtObj(lastmod,bLocalTime,dtObj);
if (CkDateTime_getLastMethodSuccess(lastmod) == FALSE) {
printf("This should never really happen!\n");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(lastmod);
CkDtObj_Dispose(dtObj);
return;
}
printf("%d-%d-%d %d:%d:%d\n",CkDtObj_getDay(dtObj),CkDtObj_getMonth(dtObj),CkDtObj_getYear(dtObj),CkDtObj_getHour(dtObj),CkDtObj_getMinute(dtObj),CkDtObj_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"
// }
// }
//
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkDateTime_Dispose(lastmod);
CkDtObj_Dispose(dtObj);
}