Start-Transcript
Windows PowerShell セッションの全体または一部を記録したテキスト ファイルを作成します。
構文
Start-Transcript [[-Path] <string>] [-Append] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]
説明
Start-Transcript コマンドレットは、Windows PowerShell セッションの全体または一部を記録したテキスト ファイルを作成します。このトランスクリプトには、ユーザーが入力するすべてのコマンド、およびコンソールに表示されるすべての出力が含まれます。
パラメーター
-Append
既存のファイルの最後に、新しいトランスクリプトを追加します。Path パラメーターを使用してファイルを指定します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Force
コマンドレットが既存の読み取り専用ファイルにトランスクリプトを追加するのを許可します。読み取り専用ファイルに対して使用した場合、ファイルのアクセス許可が読み取り - 書き込みに変更されます。Force パラメーターを使用しても、コマンドレットはセキュリティ制限を上書きできません。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-NoClobber
既存のファイルを上書きしません (内容を置き換えません)。既定では、指定したパスにトランスクリプトファイルが存在する場合、Start-Transcript は警告なしにファイルを上書きします。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Path <string>
トランスクリプト ファイルの場所を指定します。.txt ファイルへのパスを入力します。ワイルドカードは使用できません。
パスを指定しない場合、Start-Transcript によって $Transcript グローバル変数の値に含まれているパスが使用されます。この変数を作成していない場合、Start-Transcript によって、トランスクリプトは、\PowerShell_transcript.<time-stamp>.txt ファイルとして $Home\My Documents ディレクトリに格納されます。
存在しないディレクトリがパスに含まれている場合、コマンドは失敗します。
必須 |
false |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
None パイプを使用してこのコマンドレットにオブジェクトを渡すことはできません。 |
出力 |
System.String Start-Transcript は、確認メッセージが含まれている文字列と、出力ファイルへのパスを返します。 |
注
トランスクリプトを停止するには、Stop-Transcript コマンドレットを使用します。
セッション全体を記録するには、Start-Transcript コマンドをプロファイルに追加します。詳細については、「about_Profiles」を参照してください。
例 1
C:\PS>start-transcript
説明
-----------
このコマンドは、既定のファイルの場所でトランスクリプトを開始します。
例 2
C:\PS>start-transcript -path c:\transcripts\transcript0.txt -noclobber
説明
-----------
このコマンドは、C:\transcripts の Transcript0.txt ファイルでトランスクリプトを開始します。NoClobber パラメーターは、既存のファイルが上書きされることを防止します。Transcript0.txt ファイルが既に存在している場合、コマンドは失敗します。