Export (0) Print
Expand All
Expand Minimize

New-SPEnterpriseSearchFileFormat

SharePoint 2013

Updated: June 18, 2013

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

Adds the ability to parse a new file format.

New-SPEnterpriseSearchFileFormat [-FormatId] <String> [-FormatName] <String> [-MimeType] <String> -SearchApplication <SearchServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

FormatId

Required

System.String

Specifies the file name extension of the format to parse.

FormatName

Required

System.String

Specifies the name of the format to parse. Usually this is the name of the application handling the format.

MimeType

Required

System.String

Specifies the mime type of the format to parse.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application for which to add the new 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.

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

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

Detailed Description

The New-SPEnterpriseSearchFileFormat cmdlet enables the content processing component to parse files with a specified file format and file name extension. The cmdlet can only enable parsing of the file format and file name extension if the server that hosts the content processing component has a relevant third-party filter-based format handler (iFilter) installed. You can use the Get-SPEnterpriseSearchFileFormat cmdlet to verify that an iFilter is installed for a specified file format.

During iFilter installation, the operating system registered the iFilter with one or more file name extensions. Use the New-SPEnterpriseSearchFileFormat cmdlet for each registered file name extension that you want to enable the content processing component to parse. Do this on each server that hosts a content processing component in the Search service application.

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.

Input Types

Return Types

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

$ssa = Get-SPEnterpriseSearchServiceApplication
New-SPEnterpriseSearchFileFormat –SearchApplication $ssa sample SampleApp application/SampleApp

This example uses the New-SPEnterpriseSearchFileFormat cmdlet to enable the content processing component in the Search service application referenced by $ssa to parse files that have the file name extension "sample", the file format "SampleApp", and the mime type "application/SampleApp".

Change History

Date Description

June 18, 2013

Added information about when changes are effective.

July 16, 2012

Initial publication

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