SGen タスクSGen Task

指定されたアセンブリの種類に対応する XML シリアル化アセンブリを作成します。Creates an XML serialization assembly for types in the specified assembly. このタスクは、XML シリアライザー ジェネレーター ツール (Sgen.exe) をラップするタスクです。This task wraps the XML Serializer Generator Tool (Sgen.exe). 詳細については、「XML シリアライザー ジェネレーター ツール (Sgen.exe)」を参照してください。For more information, see XML Serializer Generator Tool (Sgen.exe).

パラメーターParameters

SGen タスクのパラメーターの説明を次の表に示します。The following table describes the parameters of the SGen task.

パラメーターParameter 説明Description
BuildAssemblyName 必須の String 型のパラメーターです。Required String parameter.

シリアル化コード生成の対象となるアセンブリ。The assembly to generate serialization code for.
BuildAssemblyPath 必須の String 型のパラメーターです。Required String parameter.

シリアル化コード生成の対象となるアセンブリのパス。The path to the assembly to generate serialization code for.
DelaySign 省略可能な Boolean 型のパラメーターです。Optional Boolean parameter.

true の場合、完全署名されたアセンブリを必要とすることが指定されます。If true, specifies that you want a fully signed assembly. false の場合、アセンブリに公開キーを含めることだけを要求するように指定されます。If false, specifies that you only want to place the public key in the assembly.

KeyFile または KeyContainer パラメーターと併用しない限り、このパラメーターには何の効果もありません。This parameter has no effect unless used with either the KeyFile or KeyContainer parameter.
KeyContainer 省略可能な String 型のパラメーターです。Optional String parameter.

キー ペアを保持するコンテナーを指定します。Specifies a container that holds a key pair. こうすると、アセンブリ マニフェストに公開キーを挿入することによって、アセンブリに対する署名が行われます。This will sign the assembly by inserting a public key into the assembly manifest. 次に、タスクは最終的なアセンブリに秘密キーで署名します。The task will then sign the final assembly with the private key.
KeyFile 省略可能な String 型のパラメーターです。Optional String parameter.

アセンブリに署名するためのキー ペアまたは公開キーを指定します。Specifies a key pair or a public key to use to sign an assembly. コンパイラは、アセンブリ マニフェストに公開キーを挿入し、最終的なアセンブリに秘密キーで署名します。The compiler inserts the public key in the assembly manifest and then signs the final assembly with the private key.
Platform 省略可能な String 型のパラメーターです。Optional String parameter.

出力アセンブリの生成に使用されるコンパイラ プラットフォームを取得または設定します。Gets or Sets the Compiler Platform used to generate the output assembly. このパラメーターの値には、x86x64、または anycpu を指定できます。This parameter can have a value of x86, x64, or anycpu. 既定値は anycpu です。Default is anycpu.
References 省略可能な String[] 型のパラメーターです。Optional String[] parameter.

XML シリアル化が必要な型によって参照されるアセンブリを指定します。Specifies the assemblies that are referenced by the types requiring XML serialization.
SdkToolsPath 省略可能な String 型のパラメーターです。Optional String parameter.

resgen.exe などの SDK ツールのパスを指定します。Specifies the path to the SDK tools, such as resgen.exe.
SerializationAssembly 省略可能な ITaskItem[] 型の出力パラメーターです。Optional ITaskItem[] output parameter.

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

生成されるシリアル化アセンブリの名前を指定します。Specifies the name of the generated serialization assembly.
ShouldGenerateSerializer 必須の Boolean 型のパラメーターです。Required Boolean parameter.

true の場合、SGen タスクでシリアル化アセンブリを生成する必要があります。If true, the SGen task should generate a serialization assembly.
Timeout 省略可能な Int32 型のパラメーターです。Optional Int32 parameter.

タスク実行を終了するまでの時間をミリ秒単位で指定します。Specifies the amount of time, in milliseconds, after which the task executable is terminated. 既定値は Int.MaxValue であり、タイムアウト期限がないことを示します。The default value is Int.MaxValue, indicating that there is no time out period.
ToolPath 省略可能な String 型のパラメーターです。Optional String parameter.

タスクが基になる実行可能ファイル (sgen.exe) を読み込む場所を指定します。Specifies the location from where the task will load the underlying executable file (sgen.exe). このパラメーターを指定しないと、MSBuildMSBuild を実行しているフレームワークのバージョンに対応する SDK インストール パスがタスクに使用されます。If this parameter is not specified, the task uses the SDK installation path corresponding to the version of the framework that is running MSBuildMSBuild.
Types 省略可能な String[] 型のパラメーターです。Optional String[] parameter.

シリアル化コードを生成する特定の型の一覧を取得または設定します。Gets or sets a list of specific Types to generate serialization code for. SGen は、これらの型に対してのみ、シリアル化コードを生成します。SGen will generate serialization code only for those types.
UseProxyTypes 必須の Boolean 型のパラメーターです。Required Boolean parameter.

true の場合、SGen タスクでは XML Web サービス プロキシ型に対してのみシリアル化コードを生成します。If true, the SGen task generates serialization code only for the XML Web service proxy types.

コメントRemarks

上記のパラメーター以外に、このタスクは ToolTaskExtension クラスからパラメーターを継承します。このクラス自体は、ToolTask クラスから継承されます。In addition to the parameters listed above, this task inherits parameters from the ToolTaskExtension class, which itself inherits from the ToolTask class. これらの追加のパラメーターの一覧とその説明については、「ToolTaskExtension 基本クラス」を参照してください。For a list of these additional parameters and their descriptions, see ToolTaskExtension Base Class.

関連項目See Also

Task Reference (タスク リファレンス) Task Reference
タスク Tasks
MSBuild の概念MSBuild Concepts