New-SPExcelUserDefinedFunction
适用于: SharePoint Server 2010
上一次修改主题: 2015-03-09
向 Excel Services 应用程序 中添加新的用户定义函数。
Syntax
New-SPExcelUserDefinedFunction -Assembly <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssemblyLocation <GAC | LocalFile>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Enable <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
详细说明
New-SPExcelUserDefinedFunction cmdlet 向 Excel Services 应用程序 Web 服务应用程序 中添加用户定义的函数。Excel Services 应用程序 仅使用在用户定义函数列表中拥有条目的用户定义函数。用户定义的函数是可以使用标准 Excel Services 应用程序 公式语法从 Excel Services 应用程序 工作簿调用的托管代码程序集。这些程序集可以执行自定义逻辑或其他操作,如刷新数据。Windows PowerShell cmdlet 对位于用户定义函数列表中的条目执行操作,而不对程序集执行操作。
有关此 cmdlet 的权限和最新信息,请参阅联机文档 (https://go.microsoft.com/fwlink/?LinkId=163185)。
Parameters
参数 | 是否必需 | 类型 | 说明 |
---|---|---|---|
Assembly |
必需 |
System.String |
指定强类型的程序集名称。该名称在用户定义的函数的列表中必须唯一。名称最多可包含 4096 个字母数字字符。 键入的值必须为字母数字字符串;例如: -- SampleCompany.SampleApplication.SampleUdf -- C:\UDFs\SampleUdf.dll -- \\MyNetworkServer\UDFs\SampleUdf.dll |
ExcelServiceApplication |
必需 |
Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind |
指定包含用户定义函数列表的 Excel Services 应用程序 Web 服务应用程序。 键入的值必须是 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;服务器场中 Excel Services 应用程序 Web 服务应用程序 的有效名称(例如 MyExcelService1);或有效 SPExcelServiceApplication 对象的实例。 |
AssemblyLocation |
可选 |
Microsoft.Office.Excel.Server.AssemblyLocation |
指定程序集的存储位置。默认值为 GAC。 键入的值必须为以下项之一:GAC 或 LocalFile。 |
AssignmentCollection |
可选 |
Microsoft.SharePoint.PowerShell.SPAssignmentCollection |
管理对象以便正确进行处理。使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。 备注 在使用 Global 参数时,所有对象均包含在全局存储中。如果未立即使用对象,或未通过使用 Stop-SPAssignment 命令来处理对象,则可能会发生内存不足的情况。 |
Confirm |
可选 |
System.Management.Automation.SwitchParameter |
在执行命令之前提示您确认。有关详细信息,请键入以下命令:get-help about_commonparameters |
Description |
可选 |
System.String |
指定用户定义的函数的友好说明。名称最多可包含 4096 个字母数字字符。默认值为空字符串。 键入的值必须是由字母数字字符组成的有效字符串;例如,“这是用于整合报告的用户定义的函数”。 |
Enable |
可选 |
System.Management.Automation.SwitchParameter |
激活用户定义的函数以用于 Excel Services 应用程序。默认值为 True。 |
WhatIf |
可选 |
System.Management.Automation.SwitchParameter |
显示一条描述命令作用的消息,而不执行命令。有关详细信息,请键入以下命令:get-help about_commonparameters |
输入类型
返回类型
Example
--------------示例 1--------------
New-SPExcelUserDefinedFunction -ExcelServiceApplication "MyExcelService" -Assembly "SampleCompany.SampleApplication.SampleUdf" -AssemblyLocation GAC
此示例将 SampleComany.SampleApplication.SampleUdf
文件作为新的用户定义函数添加到名为 MyExcelService
的 Excel Services 应用程序 Web 服务应用程序 中。
用户定义函数程序集将部署到全局程序集缓存 (GAC) 中。
--------------示例 2--------------
Get-SPExcelServiceApplication | New-SPExcelUserDefinedFunction -Assembly "SampleCompany.SampleApplication.SampleUdf" -AssemblyLocation GAC
此示例将 SampleComany.SampleApplication.SampleUdf
文件添加到服务器场中的每个 Excel Services 应用程序 Web 服务应用程序 中。
用户定义函数程序集将部署到全局程序集缓存 (GAC) 中。
See Also
Reference
Get-SPExcelUserDefinedFunction
Remove-SPExcelUserDefinedFunction
Set-SPExcelUserDefinedFunction