SGen タスク

  • [アーティクル]

指定されたアセンブリの種類に対応する XML シリアル化アセンブリを作成します。 このタスクは、XML シリアライザー ジェネレーター ツール (Sgen.exe) をラップするタスクです。 詳細については、「XML シリアライザー ジェネレーター ツール (Sgen.exe)」を参照してください。

パラメーター

SGen タスクのパラメーターの説明を次の表に示します。

パラメーター 説明
BuildAssemblyName 必須の String 型のパラメーターです。

シリアル化コード生成の対象となるアセンブリ。
BuildAssemblyPath 必須の String 型のパラメーターです。

シリアル化コード生成の対象となるアセンブリのパス。
DelaySign 省略可能な Boolean 型のパラメーターです。

true の場合、アセンブリに公開キーを含めることだけを要求するように指定されます。 false の場合、完全署名されたアセンブリを必要とすることが指定されます。

KeyFile または KeyContainer パラメーターと併用しない限り、このパラメーターには何の効果もありません。
KeyContainer 省略可能な String 型のパラメーターです。

キー ペアを保持するコンテナーを指定します。 こうすると、アセンブリ マニフェストに公開キーを挿入することによって、アセンブリに対する署名が行われます。 次に、タスクは最終的なアセンブリに秘密キーで署名します。
KeyFile 省略可能な String 型のパラメーターです。

アセンブリに署名するためのキー ペアまたは公開キーを指定します。 コンパイラは、アセンブリ マニフェストに公開キーを挿入し、最終的なアセンブリに秘密キーで署名します。
Platform 省略可能な String 型のパラメーターです。

出力アセンブリの生成に使用されるコンパイラ プラットフォームを取得または設定します。 このパラメーターの値には、x86、x64、または anycpu を指定できます。 既定値は anycpu です。
References 省略可能な String[] 型のパラメーターです。

XML シリアル化が必要な型によって参照されるアセンブリを指定します。
SdkToolsPath 省略可能な String 型のパラメーターです。

resgen.exe などの SDK ツールのパスを指定します。
SerializationAssembly 省略可能な ITaskItem[] 型の出力パラメーターです。

生成されたシリアル化アセンブリが格納されます。
SerializationAssemblyName 省略可能な String 型のパラメーターです。

生成されるシリアル化アセンブリの名前を指定します。
ShouldGenerateSerializer 必須の Boolean 型のパラメーターです。

true の場合、SGen タスクでシリアル化アセンブリを生成する必要があります。
Timeout 省略可能な Int32 型のパラメーターです。

タスク実行を終了するまでの時間をミリ秒単位で指定します。 既定値は Int.MaxValue であり、タイムアウト期限がないことを示します。
ToolPath 省略可能な String 型のパラメーターです。

タスクが基になる実行可能ファイル (sgen.exe) を読み込む場所を指定します。 このパラメーターを指定しない場合、タスクでは、MSBuild を実行しているフレームワークのバージョンに対応する SDK インストール パスが使用されます。
Types 省略可能な String[] 型のパラメーターです。

シリアル化コードを生成する特定の型の一覧を取得または設定します。 SGen は、これらの型に対してのみ、シリアル化コードを生成します。
UseProxyTypes 必須の Boolean 型のパラメーターです。

true の場合、SGen タスクでは XML Web サービス プロキシ型に対してのみシリアル化コードを生成します。

ToolTaskExtension パラメーター

このタスクが ToolTaskExtension クラスを継承します。このクラスは ToolTask クラスから継承され、さらに、このクラス自体は Task から継承されます。 この継承チェーンにより、これらのクラスから派生したタスクにいくつかのパラメーターが追加されます。

基本クラスのパラメーターの説明を次の表に示します。

パラメーター 説明
EchoOff 省略可能な bool 型のパラメーターです。

true に設定すると、このタスクは /Q を cmd.exe コマンド ラインに渡して、コマンド ラインが stdout にコピーされないようにします。
EnvironmentVariables 省略可能な String 型の配列パラメーターです。

セミコロンで区切られた環境変数定義の配列。 各定義では、環境変数の名前と値を等号で区切って指定する必要があります。 これらの変数は、標準の環境ブロックに加え (または標準の環境ブロックを選択的にオーバーライドして)、子の実行可能ファイルに渡されます。 たとえば、「 Variable1=Value1;Variable2=Value2 」のように入力します。
ExitCode 省略可能な Int32 型の読み取り専用出力パラメーターです。

実行したコマンドの終了コードを示します。 タスクがエラーを記録した一方で、プロセスの終了コードが 0 (成功) だった場合、これは -1 に設定されます。
LogStandardErrorAsError 省略可能な bool 型のパラメーターです。

true の場合、標準エラー ストリームで受け取ったすべてのメッセージがエラーとして記録されます。
StandardErrorImportance 省略可能な String 型のパラメーターです。

標準エラー ストリームのテキストを記録するときに使用する重要度です。
StandardOutputImportance 省略可能な String 型のパラメーターです。

標準出力ストリームのテキストを記録するときに使用する重要度です。
Timeout 省略可能な Int32 型のパラメーターです。

タスク実行を終了するまでの時間をミリ秒単位で指定します。 既定値は Int.MaxValue であり、タイムアウト期限がないことを示します。 タイムアウトはミリ秒単位です。
ToolExe 省略可能な string 型のパラメーターです。

プロジェクトで実装すると、ToolName をオーバーライドできます。 タスクでオーバーライドすると、ToolName を保持できます。
ToolPath 省略可能な string 型のパラメーターです。

タスクで基になる実行可能ファイルを読み込む場所を指定します。 このパラメーターを指定しない場合、タスクでは、MSBuild を実行しているフレームワークのバージョンに対応する SDK インストール パスが使用されます。
UseCommandProcessor 省略可能な bool 型のパラメーターです。

true に設定した場合、このタスクで直接コマンドを実行する代わりに、コマンド ラインのバッチ ファイルを作成し、そのファイルをコマンド プロセッサで実行します。
YieldDuringToolExecution 省略可能な bool 型のパラメーターです。

true に設定した場合、このタスクは、その実行時にノードを生成します。

関連項目