Delphi DLL
Delphi DLL
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 Delphi DLL Downloads
uses
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, DtObj, JsonObject, CkDateTime;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
url: PWideChar;
jsonReply: PWideChar;
json: HCkJsonObject;
fileSize: Integer;
lastmod: HCkDateTime;
bLocalTime: Boolean;
unixTime: Integer;
dtObj: HCkDtObj;
begin
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) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
// 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) then
begin
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('Failed.');
Exit;
end;
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('--------');
Memo1.Lines.Add('Server relative URL: ' + CkJsonObject__stringOf(json,'d.ServerRelativeUrl'));
fileSize := CkJsonObject_IntOf(json,'d.Length');
Memo1.Lines.Add('File Size = ' + IntToStr(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;
Memo1.Lines.Add(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;
Memo1.Lines.Add(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);
Memo1.Lines.Add('Unix time: ' + IntToStr(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) then
begin
Memo1.Lines.Add('This should never really happen!');
Exit;
end;
Memo1.Lines.Add(IntToStr(CkDtObj_getDay(dtObj)) + '-' + IntToStr(CkDtObj_getMonth(dtObj)) + '-' + IntToStr(CkDtObj_getYear(dtObj))
+ ' ' + IntToStr(CkDtObj_getHour(dtObj)) + ':' + IntToStr(CkDtObj_getMinute(dtObj)) + ':' + IntToStr(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);
end;