Export (0) Print
Expand All

Get-SPHelpCollection

 

Applies to: SharePoint Server 2010, SharePoint Foundation 2010

Topic Last Modified: 2010-02-15

Returns Help collection files.

Get-SPHelpCollection [-AssignmentCollection <SPAssignmentCollection>] [-Name <String>]

The Get-SPHelpCollection cmdlet reads the specified Help collection files. If the Name parameter is not specified, this cmdlet returns all installed Help collection files.

 

Parameter Required Type Description

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.

noteNote
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.

Name

Optional

System.String

Specifies the name of the Help collection files to get.

The type must be a valid name of a Help collection folder; for example, HelpDocs1.

 

Error Description

 

Exceptions Description

------------------EXAMPLE------------------

Get-SPHelpCollection

This example gets all installed Help collection files.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft