Install-SPHelpCollection
指定したヘルプ サイト コレクション ファイルを現在のファームにインストールします。
構文
InstallAll
Install-SPHelpCollection
[-All]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
InstallOne
Install-SPHelpCollection
-LiteralPath <String>
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
説明
このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。
Install-SPHelpCollection コマンドレットは、現在のファームに SharePoint 製品のヘルプ サイト コレクション ファイルをインストールします。 特定のカスタム ヘルプ コレクション ファイルをインストールするには、LiteralPath パラメーターを使います。 LiteralPath パラメーターを指定しない場合は、ヘルプ サイト コレクション内の使用できるヘルプがすべてインストールされ、既存のヘルプ コレクション ファイルが上書きされます。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
例
Install-SPHelpCollection -LiteralPath 'C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\1033\OSSAdmin.cab'
この例では、指定したヘルプ コレクションを現在のファームにインストールします。
パラメーター
-All
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
LiteralPath パラメーターが指定されていない場合は、ヘルプ サイト コレクションの %Program Files%\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\<LCID> のすべてのヘルプ コレクション CAB がインストールされ、既存のヘルプ コレクションが上書きされるように指定します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InstallAll
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AssignmentCollection
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。 メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。
Global パラメーターが使用されている場合は、オブジェクトはすべてグローバル ストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。
パラメーターのプロパティ
| 型: | SPAssignmentCollection |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LiteralPath
該当: SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019
ヘルプ サイト コレクションの cab ファイル内にある特定のカスタム ヘルプ ファイルへの正確なパスを指定します。
この型は、次のいずれかの形式の有効なパスであることが必要です。
- C:\folder_name
- \\server_name\folder_name
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InstallOne
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。