Export (0) Print
Expand All

Stop-SPInfoPathFormTemplate

 

Applies to: SharePoint Server 2013 Enterprise

Topic Last Modified: 2013-12-18

Disables a InfoPath 2013 form template on a farm before an upgrade.

Stop-SPInfoPathFormTemplate [-Identity] <SPFormTemplatePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-TimeLeft <Nullable>] [-WhatIf [<SwitchParameter>]]

The Stop-SPInfoPathFormTemplate cmdlet quiesces, or disables, an InfoPath 2013 form template before it upgrades the form. Before a form is updated it is quiesced, which disables access to the form. Use Start-SPIPFormTemplate to unquiesce, or activate, a form template after the form is upgraded.

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.InfoPath.Server.Cmdlet.SPFormTemplatePipeBind

Specifies the InfoPath 2013 form template to start.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a form template (for example, InfoPathFormTemplate1); a valid name of a form template files (for example, FormTemplateFile1.xsn); or an instance of a valid SPFormTemplate 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

TimeLeft

Optional

System.Nullable

Specifies the time duration, in minutes, before the form template will be quiesced. The default value is 0.

An integer value in the range from 0 to 1440.

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

Stop-SPInfoPathFormTemplate -Identity formName.xsn

This example disables a form template for a specified name.

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