Remove-SPExcelUserDefinedFunction
Applies to: SharePoint Server 2010
Topic Last Modified: 2010-02-11
Removes a user-defined function from Excel Services Application.
Syntax
Remove-SPExcelUserDefinedFunction [-Identity] <SPExcelUDFPipeBind> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Remove-SPExcelUserDefinedFunction cmdlet removes a user-defined function from the list of user-defined functions. User-defined functions are managed code assemblies that can be called from an 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. The Windows PowerShell cmdlets operate on the entries in the user-defined function list, but do not operate on the assemblies.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Microsoft.Office.Excel.Server.Cmdlet.SPExcelUDFPipeBind |
Specifies the SPExcelUserDefinedFunction object that you want to remove. 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 list of user-defined functions. 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. |
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 |
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--------------
Remove-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity "SampleCompany.SampleApplication.SampleUdf"
This example removes the SampleCompany.SampleApplication.SampleUdf user-defined function from the list of user-defined functions that is in the Excel Services Application Web service application named MyExcelService.
--------------EXAMPLE 2--------------
Get-SPExcelServiceApplication | Remove-SPExcelUserDefinedFunction -Identity "SampleCompany.SampleApplication.SampleUdf"
This example removes the SampleCompany.SampleApplication.SampleUdf user-defined function from the list of user-defined functions for every Excel Services Application Web service application in the farm.