JDBC Driver for Microsoft SharePoint

Build 25.0.9434

DownloadDocument

Downloads a document from a SharePoint document library. Helps users retrieve SharePoint-stored files for offline use or processing.

Input

Name Type Required Accepts Output Streams Description
File String False False The local file path where the downloaded document should be saved, including the new filename. Example: 'C:/Users/User/Desktop/Document.docx'.
Library String True False The name of the SharePoint document library from which the file will be downloaded. Example: 'Shared Documents'.
RemoteFile String True False The path of the document on the SharePoint server. This can be either the full URL (such as 'https://yoursharepointsite.com/Shared Documents/document.docx') or just the file name. If only the name is provided, the latest version will be downloaded.
FileStream String False True The OutputStream to write the downloaded document. This is only used if File is not specified.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the download operation was successful. Returns 'true' if successful, otherwise 'false'.
FileData String The BASE64 encoded content of the downloaded document. This is only returned if File and FileStream are not specified.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434