Export (0) Print
Expand All

Set-SPDataConnectionFile

Published: May 12, 2010

Sets properties of a data connection file.

Set-SPDataConnectionFile [-Identity] <SPDataConnectionFilePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Category <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-DisplayName <String>] [-WebAccessible <String>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Identity

Required

Microsoft.Office.InfoPath.Server.Cmdlet.SPDataConnectionFilePipeBind

Specifies the data connection file to update.

The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile 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.

Category

Optional

System.String

Sets an arbitrary category on the file which can be used to group the files. The category name can have a maximum of 255 characters.

The type must be a valid string value; for example, Category1.

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

Description

Optional

System.String

Sets the description for the data connection file. The name can be a maximum of 4096 alphanumeric characters.

The type must be a valid string; for example, Description of my universal data connection file.

DisplayName

Optional

System.String

Specifies the display name that describes the data connection file. The name can have a maximum of 255 characters.

The type must be a valid string; for example, InfoPathUDC1.

WebAccessible

Optional

System.String

Specifies that the universal data connection file can be accessed by using the Web service. If false, only the forms server can retrieve the universal data connection files internally. The default value is False.

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 Set-SPDataConnectionFile cmdlet sets the properties of the data connection file specified in the Identity parameter.

Input Types

 

Return Types

 

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

Set-SPDataConnectionFile -Identity "sample.udcx" -Category "Temp"

This example updates the Category of the specified .udcx file.

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

Set-SPDataConnectionFile -Identity "sample.udcx" -DisplayName "NewDisplayName"

This example updates the DisplayName of the specified .udcx file.

--------------EXAMPLE 3-----------------

Sample.udcx" | Set-SPDataConnectionFile -Category "Temp"

This example updates the Category of the specified .udcx file.

--------------EXAMPLE 4-----------------

Get-SPDataConnectionFile | where {$_.Category -eq "Category1"}  | Set-SPDataConnectionFile -Category "Category2"

This example updates the Category field for the collection of .udcx files that are returned from a query used by the Get-SPDataConnectionFile cmdlet.

Change History

 

Date Description Reason

May 12, 2010

Initial publication

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