PowerShell Cmdlet - Set-TraceSource
 記事記号:[mg1994] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Set-TraceSource
    
概要
    Windows PowerShell コンポーネントのトレースを構成、開始、および停止します。
    
構文
    Set-TraceSource [[-Option] {None | Constructor | Dispose | Finalizer | Metho
    d | Property | Delegates | Events | Exception | Lock | Error | Errors | Warn
    ing | Verbose | WriteLine | Data | Scope | ExecutionFlow | Assert | All}] [-
    Debugger] [-FilePath <string>] [-Force] [-ListenerOption {None | LogicalOper
    ationStack | DateTime | Timestamp | ProcessId | ThreadId | Callstack}] [-Pas
    sThru] [-PSHost] [-Name] <string[]> [<CommonParameters>]
    
    Set-TraceSource [-RemoveListener <string[]>] [-Name] <string[]> [<CommonPara
    meters>]
    
    Set-TraceSource [-RemoveFileListener <string[]>] [-Name] <string[]> [<Common
    Parameters>]
    
説明
    Set-TraceSource コマンドレットは、Windows PowerShell コンポーネントのトレー
    スを構成、開始、および停止します。このコマンドレットを使用すると、トレースす
    るコンポーネントとトレースの出力先を指定できます。

パラメーター
    -Debugger [<SwitchParameter>]
        トレースをデバッガーに出力します。出力は、任意のユーザー モードまたはカ
        ーネル モード デバッガー、あるいは Microsoft Visual Studio で表示できま
        す。このパラメーターによって、既定のトレース リスナーも選択したことにな
        ります。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -FilePath <string>
        指定されたファイルにトレースを出力します。このパラメーターによって、ファ
        イル トレース リスナーも選択されます。このパラメーターを使用してトレース
        を開始した場合は、RemoveFileListener パラメーターを使用してトレースを停
        止します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        このコマンドレットが読み取り専用ファイルを上書きするのを許可します。File
        Path パラメーターと共に使用します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -ListenerOption <TraceOptions>
        出力される各トレース メッセージのプレフィックスにオプション データを追加
        します。有効な値は、"None"、"LogicalOperationStack"、"DateTime"、"Timest
        amp"、"ProcessId"、"ThreadId"、および "Callstack" です。既定値は "None" 
        です。
        
        複数のオプションを指定するには、スペースを入れずにコンマで各オプションを
        区切り、"ProcessID,ThreadID" のように二重引用符で囲みます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Name <string[]>
        トレース対象のコンポーネントを決定します。各コンポーネントのトレース ソ
        ースの名前を入力します。ワイルドカードを使用できます。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByValue, ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Option <PSTraceSourceOptions>
        トレース対象のイベントの種類を決定します。
        
        有効な値は、"None"、"Constructor"、"Dispose"、"Finalizer"、"Method"、"Pr
        operty"、"Delegates"、"Events"、"Exception"、"Lock"、"Error"、"Errors"、
        "Warning"、"Verbose"、"WriteLine"、"Data"、"Scope"、"ExecutionFlow"、"As
        sert"、および "All" です。既定値は All です。
        
        以下の値は、上記の値を組み合わせたものです。
        
        -- ExecutionFlow: (Constructor、Dispose、Finalizer、Method、Delegates、E
           vents、および Scope)
        
        -- Data: (Constructor、Dispose、Finalizer、Property、Verbose、および Wri
           teLine)
        
        -- Errors: (Error および Exception)
        
        複数のオプションを指定するには、各オプションをスペースを入れずにコンマで
        区切り、"Constructor,Dispose" のように二重引用符で囲みます。
        
        必須                         false
        位置                         2
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        トレース セッションを表すオブジェクトを返します。既定では、このコマンド
        レットによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -PSHost [<SwitchParameter>]
        トレースを Windows PowerShell ホストに出力します。このパラメーターによっ
        て、PSHost トレース リスナーも選択されます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -RemoveFileListener <string[]>
        指定されたファイルと関連付けられているファイル トレース リスナーを削除し
        て、トレースを停止します。トレース出力ファイルのパスとファイル名を入力し
        ます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -RemoveListener <string[]>
        トレース リスナーを削除してトレースを停止します。
        
        RemoveListener では以下の値が使用できます。
        
        -- PSHost (コンソール) を削除するには、「Host」と入力します。
        -- デバッガーを削除するには、「Debug」と入力します。
        -- すべてのトレース リスナーを削除するには、「*」と入力します。
        
        ファイル トレース リスナーを削除するには、RemoveFileListener パラメータ
        ーを使用します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.String
        パイプを使用して名前を含む文字列を Set-TraceSource に渡すことができます。
    
出力
    なし、または System.Management.Automation.PSTraceSource
        PassThru パラメーターを使用すると、Set-TraceSource はトレース セッション
        を表す System.Management.Automation.PSTraceSource オブジェクトを生成しま
        す。それ以外の場合、このコマンドレットによる出力はありません。
    
メモ
        トレースは、開発者がプログラムをデバッグおよび改良するときに使用する方法
        です。トレースを行うと、プログラムは内部処理の各手順について詳細なメッセ
        ージを生成します。
        
        Windows PowerShell のトレース用コマンドレットは、Windows PowerShell 開発
        者向けに設計されていますが、どのユーザーでも使用できます。トレース用コマ
        ンドレットを使用すると、Windows PowerShell の機能のほぼすべての部分を監
        視できます。
        
        "トレース ソース" は各 Windows PowerShell コンポーネントの一部としてトレ
        ースを管理し、コンポーネントのトレース メッセージを生成します。コンポー
        ネントをトレースするには、そのトレース ソースを特定します。
        
        "トレース リスナー" は、トレースの出力を受け取り、ユーザーに表示します。
        トレース データの送り先として、ユーザー モードまたはカーネル モードのデ
        バッガー、コンソール、ファイルのほか、System.Diagnostics.TraceListener 
        クラスから派生したカスタム リスナーのいずれかを選択できます。
        
        トレースを開始するには、Name パラメーターにトレース ソース (トレース対象
        のコンポーネント) を指定し、FilePath、Debugger、または PSHost パラメータ
        ーを使用してリスナー (出力先) を指定します。Options パラメーターを使用し
        てトレース対象のイベントの種類を指定し、ListenerOptions パラメーターを使
        用してトレース出力を構成します。
        
        トレースの構成を変更するには、トレースを開始する場合と同じように Set-Tra
        ceSource コマンドを実行します。Windows PowerShell は、トレース ソースで
        既にトレースが行われていることを認識します。トレースを停止し、新しい構成
        を追加し、トレースを開始または再開します。
        
        トレースを停止するには、RemoveListener パラメーターを使用します。ファイル 
        リスナーを使用するトレース (-FilePath パラメーターを指定したときに起動さ
        れるトレース) を停止するには、RemoveFileListener パラメーターを使用します。
        リスナーを削除すると、トレースは停止します。
        
        どのコンポーネントがトレース可能かを判断するには、Get-TraceSource を使用
        します。各モジュールのトレース ソースは、コンポーネントが使用中であると自
        動的に読み込まれ、Get-TraceSource の出力に含まれます。
        
    -------------------------- 例 1 --------------------------
    
    C:\PS>Set-TraceSource -Name Parameterbinding -Option ExecutionFlow -PSHost '
    -ListenerOption "ProcessID,TimeStamp"
    
    説明
    -----------
    このコマンドは、Windows PowerShell の ParameterBinding コンポーネントのトレー
    スを開始します。Name パラメーターを使用してトレース ソースを指定し、Option パ
    ラメーターを使用して ExecutionFlow トレース イベントを選択し、PSHost パラメー
    ターを使用して出力をコンソールに送る Windows PowerShell ホスト リスナーを選択
    します。ListenerOption パラメーターを指定することによって、"ProcessID" および 
    "TimeStamp" の値をトレース メッセージ プレフィックスに追加しています。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>set-tracesource -name ParameterBinding -RemoveListener Host
    
    説明
    -----------
    このコマンドは、Windows PowerShell の ParameterBinding コンポーネントのトレー
    スを停止します。Name パラメーターを使用してトレース中のコンポーネントを指定し、
    RemoveListener パラメーターを使用してトレース リスナーを指定します。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113400
    Get-TraceSource 
    Trace-Command 
    Set-PSDebug 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Set-TraceSource
ご利用数: 1973260
感想・要望・問い合わせは こちら