Get-SPExcelUserDefinedFunction

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

構文

Default (既定)

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

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

パラメーター

-AssignmentCollection

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

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

パラメーターのプロパティ

型:SPAssignmentCollection
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ExcelServiceApplication

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

リスト オブジェクト SPExcelUserDefinedFunction を含む Excel Services アプリケーション Web サービス アプリケーションを指定します。

型は、12345678-90ab-cdef-1234-567890bcdefgh の形式の有効な GUID である必要があります。ファーム内の Excel Services Application Web サービス アプリケーションの有効な名前 (MyExcelService1 など)。または有効な SPExcelServiceApplication オブジェクトのインスタンス。

パラメーターのプロパティ

型:SPExcelServiceApplicationPipeBind
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Identity

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

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

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

パラメーターのプロパティ

型:SPExcelUDFPipeBind
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:1
必須:False
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。