New-SPExcelUserDefinedFunction

向 Excel Services 应用程序中添加新的用户定义函数。

语法

Default (默认值)

New-SPExcelUserDefinedFunction
    -Assembly <String>
    -ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
    [-AssemblyLocation <AssemblyLocation>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-Description <String>]
    [-Enable]
    [-WhatIf]
    [<CommonParameters>]

说明

cmdlet New-SPExcelUserDefinedFunction 将用户定义的函数添加到Excel Services应用程序 Web 服务应用程序。 Excel Services应用程序仅使用用户定义的函数,这些函数在用户定义的函数列表中具有条目。 用户定义的函数是托管代码程序集,可以使用标准Excel Services应用程序公式语法从Excel Services应用程序工作簿调用。 这些程序集可以执行自定义逻辑或其他操作,如刷新数据。 Windows PowerShell cmdlet 对位于用户定义函数列表中的条目执行操作,而不对程序集执行操作。

有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息,请参阅 SharePoint Server cmdlet

示例

Get-SPExcelServiceApplication | New-SPExcelUserDefinedFunction -Assembly "SampleCompany.SampleApplication.SampleUdf" -AssemblyLocation GAC

本示例将 SampleComany.SampleApplication.SampleUdf 文件添加到场中的每个Excel Services Application Web 服务应用程序。

用户定义函数程序集将部署到全局程序集缓存 (GAC) 中。

参数

-Assembly

适用:SharePoint Server 2010、SharePoint Server 2013

指定强类型的程序集名称。 该名称在用户定义的函数的列表中必须唯一。 名称最多可包含 4096 个字母数字字符。

键入的值必须为字母数字字符串;例如:

-- SampleCompany.SampleApplication.SampleUdf -- C:\UDFs\SampleUdf.dll -- \\MyNetworkServer\UDFs\SampleUdf.dll

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-AssemblyLocation

适用:SharePoint Server 2010、SharePoint Server 2013

指定程序集的存储位置。 默认值为 GAC。

键入的值必须为以下项之一:GAC 或 LocalFile。

参数属性

类型:AssemblyLocation
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-AssignmentCollection

适用:SharePoint Server 2010、SharePoint Server 2013

管理对象以便正确进行处理。 使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。 通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。 在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。

使用全局参数时,所有对象均包含在全局存储中。 如果未立即使用对象,或未通过使用 Stop-SPAssignment 命令来处理对象,则可能会发生内存不足的情况。

参数属性

类型:SPAssignmentCollection
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

适用:SharePoint Server 2010、SharePoint Server 2013

执行命令前,看到确认提示。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Description

适用:SharePoint Server 2010、SharePoint Server 2013

指定用户定义的函数的友好说明。 名称最多可包含 4096 个字母数字字符。 默认值为空字符串。

键入的值必须是由字母数字字符组成的有效字符串;例如,“这是用于整合报告的用户定义的函数”。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Enable

适用:SharePoint Server 2010、SharePoint Server 2013

激活与 Excel Services Application 一起使用的用户定义函数。 默认值为 True。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ExcelServiceApplication

适用:SharePoint Server 2010、SharePoint Server 2013

指定包含用户定义函数列表Excel Services应用程序 Web 服务应用程序。

类型必须是有效的 GUID,格式为 12345678-90ab-cdef-1234-567890bcdefgh;场中Excel Services应用程序 Web 服务应用程序的有效名称 (例如 MyExcelService1) ;或有效 SPExcelServiceApplication 对象的实例。

参数属性

类型:SPExcelServiceApplicationPipeBind
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-WhatIf

适用:SharePoint Server 2010、SharePoint Server 2013

显示一条描述命令作用的消息,而不执行命令。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters