Get-SPExcelFileLocation

 

Applies to: SharePoint Server 2010

Topic Last Modified: 2010-02-11

Banner stating end of support date for Office 2010 with link to more info

Returns a trusted file location or a list of trusted file locations.

Syntax

Get-SPExcelFileLocation [[-Identity] <SPExcelFileLocationPipeBind>] -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>]

Detailed Description

The Get-SPExcelFileLocation cmdlet gets locations from which Excel Services Application loads workbooks. Excel Services Application loads only workbooks that are stored in a trusted file location. Properties of trusted file locations control how workbooks can be used when loaded by Excel Services Application. Excel Services Application always enforces the properties that are defined by the trusted file location from which a workbook was loaded. The properties of the trusted file location to use are determined through comparison of the file path for the workbook with the address of the trusted file location.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Office.Excel.Server.Cmdlet.SPExcelFileLocationPipeBind

Specifies the SPExcelFileLocation object to return. If the Identity parameter is not specified, the cmdlet returns all the file locations in the specified. Excel Services Application Web service application.

The type must be a valid string that identifies the file location, in the form http://myPortal/myTeam; a valid string that identifies the path, in the form C:\folder_name; a valid UNC path to a trusted location in the form, \\computer_name\share; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an instance of a valid SPExcelFileLocation object.

ExcelServiceApplication

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind

Specifies the Excel Services Application Web service application that contains the SPExcelFileLocation list object.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

Note

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.

Input Types

Return Types

Example

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

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation

This example displays a list of trusted file locations for the Excel Services Application Web service application named MyExcelService.

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

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation | Format-list *

This example displays a list of trusted file locations for the Excel Services Application Web service application named MyExcelService, and then formats the list of properties into a table.

--------------EXAMPLE 3--------------

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelFileLocation | where {$_.ExternalDataAllowed -ne "None"}

This example displays a list of trusted file locations that allow external data connectivity for the Excel Services Application Web service application named MyExcelService.