VB.NET

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. VB.NET

Dim success As Boolean = False

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

Dim http As New Chilkat.Http

' If SharePoint Windows classic authentication is used, then set the 
' Login, Password, LoginDomain, and NtlmAuth properties.
http.Login = "SHAREPOINT_USERNAME"
http.Password = "SHAREPOINT_PASSWORD"
http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
http.NtlmAuth = 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
http.Accept = "application/json;odata=verbose"
http.AcceptCharset = "utf-8"

Dim url As String = "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')"

Dim jsonReply As String = http.QuickGetStr(url)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


' Examine the file's metadata in JSON format.
Dim json As New Chilkat.JsonObject
json.Load(jsonReply)
json.EmitCompact = 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 (http.LastStatus <> 200) Then
    Debug.WriteLine(json.Emit())
    Debug.WriteLine("Failed.")
    Exit Sub
End If


Debug.WriteLine(json.Emit())

Debug.WriteLine("--------")
Debug.WriteLine("Server relative URL: " & json.StringOf("d.ServerRelativeUrl"))

Dim fileSize As Integer = json.IntOf("d.Length")
Debug.WriteLine("File Size = " & fileSize)

Dim lastmod As New Chilkat.CkDateTime
lastmod.SetFromTimestamp(json.StringOf("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:
Dim bLocalTime As Boolean = False
Debug.WriteLine(lastmod.GetAsRfc822(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
Debug.WriteLine(lastmod.GetAsRfc822(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). 
Dim unixTime As Integer = lastmod.GetAsUnixTime(bLocalTime)
Debug.WriteLine("Unix time: " & 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:
Dim dtObj As New Chilkat.DtObj
lastmod.ToDtObj(bLocalTime,dtObj)

If (lastmod.LastMethodSuccess = False) Then
    Debug.WriteLine("This should never really happen!")
    Exit Sub
End If


Debug.WriteLine(dtObj.Day & "-" & dtObj.Month & "-" & dtObj.Year & " " & dtObj.Hour & ":" & dtObj.Minute _
     & ":" & dtObj.Second)

' -------------------------------------------------
' 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"
'   }
' }
'