Set-SPExcelUserDefinedFunction
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Sets properties of a user-defined function in Excel Services Application.
Syntax
Set-SPExcelUserDefinedFunction [-Identity] <SPExcelUDFPipeBind> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-Assembly <String>] [-AssemblyLocation <GAC | LocalFile>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Enable <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-SPExcelUserDefinedFunction cmdlet sets properties of a user-defined function assembly. Excel Services Application uses only user-defined functions that have an entry in the user-defined function list. User-defined functions are managed code assemblies that can be called from a Excel Services Application workbook by using standard Excel Services Application formula syntax. The assemblies can perform custom logic or other actions, such as refresh data. Windows PowerShell cmdlets operate on the entries in the user-defined function list and do not operate on the assemblies.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Office.Excel.Server.Cmdlet.SPExcelUDFPipeBind |
Specifies the SPExcelUserDefinedFunction object to update. The type must be a valid name of the code assembly; for example, SampleCompany.SampleApplication.SampleUdf; or an instance of a valid SPExcelUDF object. |
ExcelServiceApplication |
Required |
Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind |
Specifies the Excel Services Application Web service application that contains the SPExcelUserDefinedFunction list object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object. |
Assembly |
Optional |
System.String |
Specifies the strongly-typed name of the assembly. The name must be unique in the list of user-defined functions, and cannot be more than 4096 alphanumeric characters long. The type must be a string of alphanumeric characters; for example, SampleCompany.SampleApplication.SampleUdf, C:\UDFs\SampleUdf.dll, or \\MyNetworkServer\UDFs\SampleUdf.dll. |
AssemblyLocation |
Optional |
Microsoft.Office.Excel.Server.AssemblyLocation |
Specifies the location where the assembly is stored. The type must be one of the following: GAC or LocalFile. |
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 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 |
Description |
Optional |
System.String |
Specifies a display description for the user-defined function. The name cannot be more than 4096 alphanumeric characters long. The type must be a string of alphanumeric characters; for example, this is the user-defined function for consolidation reports. |
Enable |
Optional |
System.Management.Automation.SwitchParameter |
Activates the user-defined function for use with Excel Services Application. |
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 |
Input Types
Return Types
Example
--------------EXAMPLE 1--------------
Set-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity SampleCompany.SampleApplication.SampleUdf -Description "This is the new description for the sample UDF"
This example changes the description of the user-defined function (UDF) to the UDF SampleCompany.SampleApplication.SampleUdf file for the Excel Services Application Web service application named My Excel Service.
--------------EXAMPLE 2--------------
Get-SPExcelServiceApplication "My Excel Service" | Set-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -Enable: $false
This example disables the sample UDF SampleCompany.SampleApplication.SampleUdf file from the Excel Services Application named My Excel Service.