Set-SPExcelUserDefinedFunction
Excel Services アプリケーションのユーザー定義関数のプロパティを設定します。
構文
Set-SPExcelUserDefinedFunction
[-Identity] <SPExcelUDFPipeBind>
-ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
[-Assembly <String>]
[-AssemblyLocation <AssemblyLocation>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Description <String>]
[-Enable]
[-WhatIf]
[<CommonParameters>] 説明
コマンドレットは Set-SPExcelUserDefinedFunction 、ユーザー定義関数アセンブリのプロパティを設定します。
Excel Services アプリケーションでは、ユーザー定義関数リストにエントリがあるユーザー定義関数のみが使用されます。
ユーザー定義関数は、標準の Excel Services アプリケーション式構文を使用して、Excel Services アプリケーション ブックから呼び出すことができるマネージ コード アセンブリです。
このアセンブリでは、データの更新など、カスタムのロジックやその他のアクションを実行できます。
Windows PowerShell のコマンドレットは、ユーザー定義関数の一覧のエントリには影響しますが、アセンブリには影響しません。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
-------------- 例 1 --------------
Set-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity SampleCompany.SampleApplication.SampleUdf -Description "This is the new description for the sample UDF"次の使用例は、ユーザー定義関数 (UDF) の説明を、My Excel Service という名前の Excel Services Application Web サービス アプリケーションの UDF SampleCompany.SampleApplication.SampleUdf ファイルに変更します。
-------------- 例 2 --------------
Get-SPExcelServiceApplication "My Excel Service" | Set-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -Enable: $falseこの例では、My Excel Service という名前のExcel Services アプリケーションからサンプル UDF SampleCompany.SampleApplication.SampleUdf ファイルを無効にします。
パラメーター
-Assembly
アセンブリの厳密に型指定された名前を指定します。 名前は、ユーザー定義関数の一覧で一意である必要があり、4096 文字を超える英数字を指定することはできません。
この型は、英数字の文字列であることが必要です。たとえば、SampleCompany.SampleApplication.SampleUdf、C:\UDFs\SampleUdf.dll、\\MyNetworkServer\UDFs\SampleUdf.dll などです。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-AssemblyLocation
アセンブリが格納されている場所を指定します。
この型は、GAC または LocalFile のいずれかであることが必要です。
| Type: | AssemblyLocation |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-AssignmentCollection
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。
Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
| Type: | SPAssignmentCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-Description
ユーザー定義関数の説明として表示する文字列を指定します。 この説明の長さは、英数字で最大 4,096 文字です。
この型は、英数字の文字列であることが必要です。たとえば、「this is the user-defined function for consolidation reports」などのように指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-Enable
アプリケーションで使用するユーザー定義関数Excel Servicesアクティブ化します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-ExcelServiceApplication
SPExcelUserDefinedFunction リスト オブジェクトを含むアプリケーション Web サービス アプリケーションExcel Servicesを指定します。
型は、12345678-90ab-cdef-1234-567890bcdefgh という形式の有効な GUID である必要があります。ファーム内のExcel Services Application Web サービス アプリケーション (MyExcelService1 など) の有効な名前、または有効な SPExcelServiceApplication オブジェクトのインスタンス。
| Type: | SPExcelServiceApplicationPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-Identity
更新する SPExcelUserDefinedFunction オブジェクトを指定します。
型は、コード アセンブリの有効な名前である必要があります。たとえば、SampleCompany.SampleApplication.SampleUdf です。または有効な SPExcelUDF オブジェクトのインスタンス。
| Type: | SPExcelUDFPipeBind |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |
-WhatIf
コマンドを実行する代わりに、コマンドの実行結果を説明するメッセージを表示します。
詳細については、次のコマンドを入力します。get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013 |