Cmdlets for Microsoft SharePoint

Build 24.0.8963

DownloadAttachment

Downloads a document from the SharePoint list.

Stored Procedure Specific Information

Insert

RemoteFile can be both relative to the server, or it can be the full URL of the file. Below are some examples:

EXECUTE DownloadAttachment File = 'C:/Users/User/Desktop/DownloadedFile.txt', RemoteFile = 'https://mysite.sharepoint.com/Lists/MyCustomList/Attachments/1/FileToDownload.txt';

EXECUTE DownloadAttachment File = 'C:/Users/User/Desktop/DownloadedFile.txt', RemoteFile = '/Lists/MyCustomList/Attachments/1/FileToDownload.txt';

Input

Name Type Description
File String The path of the file to be saved.
RemoteFile String The path of the file on the server. This can be the full URL or simply the file name. If you use the name of the file, the latest version is downloaded.
Encoding String The data is output to FileData in the specified encoding.

The allowed values are NONE, BASE64.

The default value is BASE64.

ReadTimeout String How many seconds the download may run. If given, the download always fails if it runs longer than this, unlike Timeout which only triggers if the download stalls.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the operation was successful or not.
FileData String The downloaded file content. Only returned if File and FileStream is not set.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963