Get-SPExcelUserDefinedFunction

リファレンス

モジュール:: SharePointServer

適用対象:: SharePoint Server 2010, SharePoint Server 2013

ユーザー定義関数またはユーザー定義関数のコレクションを返します。

構文

Get-SPExcelUserDefinedFunction
   [[-Identity] <SPExcelUDFPipeBind>]
   -ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

説明

Get-SPExcelUserDefinedFunction コマンドレットは、ユーザー定義関数とそのプロパティを読み取るか、Excel Services Application Web サービスアプリケーションのユーザー定義関数のコレクションを返します。 Excel Services アプリケーションでは、ユーザー定義関数の一覧にあるユーザー定義関数のみが使用されます。ユーザー定義関数は、標準の Excel Services アプリケーション式構文を使用して、Excel Services アプリケーションブックから呼び出すことができるマネージコードアセンブリです。このアセンブリでは、データの更新など、カスタムのロジックやその他のアクションを実行できます。 Windows PowerShell のコマンドレットは、ユーザー定義関数の一覧のエントリには影響しますが、アセンブリには影響しません。

Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンラインドキュメントをご覧ください。

例

-------------- 例 1 --------------

Get-SPExcelServiceApplication -Identity "MyExcelService" | Get-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf

次の使用例は、MyExcelService という名前のExcel Services アプリケーション Web サービスアプリケーションにあるユーザー定義関数の一覧から、SampleCompany.SampleApplication.SampleUdf という名前のユーザー定義関数を表示します。

-------------- 例 2 --------------

Get-SPExcelServiceApplication | Get-SPExcelUserDefinedFunction | format-list

次の使用例は、ファーム内のすべてのアプリケーション Web サービスアプリケーションExcel Servicesのすべてのユーザー定義関数を表示し、結果を一覧に表示します。

パラメーター

-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

-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

取得する UserDefinedFunction オブジェクトを指定します。 Identity パラメーターを指定しない場合は、ユーザー定義関数の一覧に含まれるすべての関数が取得されます。

この型は、コードアセンブリの有効な名前 (SampleCompany.SampleApplication.SampleUdf など) または有効な SPExcelUDF オブジェクトインスタンスであることが必要です。

Type:	SPExcelUDFPipeBind
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013