Export (0) Print
Expand All
Expand Minimize

Set-SPEnterpriseSearchFileFormatState

SharePoint 2013
 

Applies to: SharePoint Server 2013 Standard, SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2014-06-06

Enables or disables parsing of a specified file format.

Set-SPEnterpriseSearchFileFormatState [-Identity] <DocumentParserFileFormatStatePipeBind> [-Enable] <$true | $false> -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

The Set-SPEnterpriseSearchFileFormatState cmdlet enables or disables the content processing component from parsing a specified file format. You can only use this cmdlet for file formats that the content processing component parses with a built-in format handler or a built-in filter-based format handler (iFilter). Use the Get-SPEnterpriseSearchFileFormat cmdlet to verify that a content processing component uses a built-in format handler or built-in iFilter for a specified file format.

To enable parsing of a file format, set Enabled to “$TRUE”. To disable parsing of a file format, set Enabled to “$FALSE”.

NoteNote:
A file format can support more than one file name extension, see Default crawled file name extensions and parsed file types in SharePoint Server 2013 for an overview. The Set-SPEnterpriseSearchFileFormatState cmdlet enables or disables parsing of all file name extensions the file format supports.

Your change is effective after you restart the SharePoint 2013 Search Host Controller process of each server that hosts a content processing component in the Search service application.

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.Server.Search.Cmdlet.DocumentParserFileFormatStatePipeBind

Specifies the identification of the file format to be disabled or enabled.

Enable

Required

System.Boolean

Specifies the activation state of the file format. The activation state can be $FALSE (disabled) or $TRUE (enabled).

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the name of the search application that contains the file format. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication 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.

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

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

$ssa = Get-SPEnterpriseSearchServiceApplication
Set-SPEnterpriseSearchFileFormatState -SearchApplication $ssa PDF $FALSE

This example uses the Set-SPEnterpriseSearchFileFormatState cmdlet to disable the format handler for the file format "PDF."

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