Download-SPFile

Save the file associated with the specified file or folder URL.

Download-SPFile -File <SPFilePipeBind[]> -TargetFolder <String> [-Overwrite [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Download-SPFile -Folder <SPFolderPipeBind> [-Recursive [<SwitchParameter>]] -TargetFolder <String> [-Overwrite [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
FileTrueSPFilePipeBind[]

The path to the file to save.

TargetFolderTrueString

The path to the folder to save the files to.

OverwriteFalseSwitchParameter

Overwrite existing files.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

2

ParameterRequiredTypeDescription
FolderTrueSPFolderPipeBind

The path to the folder to save.

RecursiveFalseSwitchParameter

Save all child folders and their files.

TargetFolderTrueString

The path to the folder to save the files to.

OverwriteFalseSwitchParameter

Overwrite existing files.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Detailed Description

Save the file associated with the specified file or folder URL.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

------------------EXAMPLE 1-----------------------

PS C:\> Download-SPFile -File "http://server_name/pages/default.aspx" -TargetFolder "c:\temp"

This saves the default.aspx file from the http://server_name/pages library.

------------------EXAMPLE 2-----------------------

PS C:\> Download-SPFile "http://server_name/documents/" -TargetFolder "c:\temp" -Recursive

This example saves all files from the http://server_name/documents library.