Get-SPCustomizedPages

Retrieves all customized (unghosted) pages at the given scope. If not returning as a string using the Start-SPAssignment and Stop-SPAssignment cmdlets to dispose of all parent objects.

Get-SPCustomizedPages -Web <SPWebPipeBind[]> [-Recurse [<SwitchParameter>]] [-AsString [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Get-SPCustomizedPages -Site <SPSitePipeBind[]> [-AsString [<SwitchParameter>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
WebTrueSPWebPipeBind[]

Specifies the URL or GUID of the Web to retrieve customized pages from.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Microsoft SharePoint Foundation 2010 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.

RecurseFalseSwitchParameter

Iterate through all child-webs of the specified web.

AsStringFalseSwitchParameter

Returns the results as a string. If this parameter is not provided the results will be returned as SPFile objects and the caller will be responsible for disposing the parent objects using the Start-SPAssignment and Stop-SPAssignment cmdlets.

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
SiteTrueSPSitePipeBind[]

The site to retrieve customized pages from. All sub-webs will be iterated through.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.

AsStringFalseSwitchParameter

Returns the results as a string. If this parameter is not provided the results will be returned as SPFile objects and the caller will be responsible for disposing the parent objects using the Start-SPAssignment and Stop-SPAssignment cmdlets.

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

Retrieves all customized (unghosted) pages at the given scope. If not returning as a string using the Start-SPAssignment and Stop-SPAssignment cmdlets to dispose of all parent objects.

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:\> $pages = Get-SPWeb http://server_name/subweb | Get-SPCustomizedPages -Recurse

This example returns back all customized, or unghosted, pages from all webs under http://server_name/subweb, inclusive.

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

PS C:\> $pages = Get-SPSite http://server_name/ | Get-SPCustomizedPages

This example returns back all customized, or unghosted, pages from all webs at the site collection http://server_name/.