Tuesday, May 20, 2008

PowerShellのGet-Helpコマンドレットを使用すると、特定のコマンドレットのヘルプを参照することができます。

このとき、パラメータ -Detailed を使用すると詳細なヘルプをみることができ、その中には使用例も含まれています。

たとえば、Get-Command 調べる場合は

PS > Get-Help Get-Command -Detailed

名前
    Get-Command

概要
    コマンドレットおよびその他の Windows PowerShell コマンド要素に関する基本情報を取得し
    ます。


構文
    Get-Command [[-argumentList] <OBJECT[]>] [-verb <STRING[]>] [-noun <STRING[]>] [-tota
    lCount <INT>] [-syntax] [-pSSnapIn <STRING[]>] [<COMMONPARAMETERS>]

    Get-Command [[-name] <STRING[]>] [[-argumentList] <OBJECT[]>] [-commandType {<ALIAS>
    | <FUNCTION> | <FILTER> | <CMDLET> | <EXTERNALSCRIPT> | <APPLICATION> | <SCRIPT> | <A
    ll>}] [-totalCount <int>] [-syntax] [<CommonParameters>]


詳細説明
    Get-Command コマンドレットは、コマンドレットおよびその他の Windows PowerShell コマン
    ド要素であるファイル、関数、Windows PowerShell プロバイダに関する基本情報を取得します
    。
:
:長いので省略
:
    -------------------------- 例 1 --------------------------

    C:\PS>get-command

    このコマンドは、すべての Windows PowerShell コマンドレットの情報を取得します。 既定で
    は、コマンドの種類 ("Cmdlet")、コマンドレットの名前、および構文の一覧が表示されます。




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

    C:\PS>get-command -verb set | format-list

    このコマンドは、set 動詞を持つすべてのコマンドレットの情報を取得し、その一部の一覧を

このように、ヘルプには使用例が含まれています。

このヘルプの中から使用例だけを取り出すには

PS >(Get-Help Get-Command -Detailed).Examples

のようにします。

ただ、毎回このように入力して使用例を取得するのは面倒なので関数を作成してみました。

#=========================================================================================
# Get-Example: コマンドレットの使用例を取得する
#
# UPDATE: 2008-05-20
#
# copyright HIRO's.NET(http://hiros-dot.net/)
#=========================================================================================
function global:Get-Examples([string]$cmdlet)
{
    (Get-Help $cmdlet -Detailed).Examples
}

この関数を使用するには、Get-Examplesの後に、使用例を取得したいコマンドレットを指定するだけです。

PS > Get-Examples Get-ExecutionPolicy

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

C:\PS>get-executionpolicy


このコマンドは、シェルの現在の実行ポリシーを取得します。


Restricted

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

C:\PS>set-executionpolicy RemoteSigned; get-executionPolicy


これらのコマンドは、シェルの実行ポリシーの新しいユーザー設定を設定してから、有効な実行ポ
リシーを表示します。 コマンドは、セミコロン (;) によって区切られます。 この例では、グルー
プ ポリシー設定が存在しないため、ユーザー設定がシェルで有効なポリシーです。


RemoteSigned
Tuesday, May 20, 2008 10:03:14 PM (Tokyo Standard Time, UTC+09:00)  #    Comments [0]  |  Trackback
Comments are closed.

Theme design by Jelle Druyts

Pick a theme: