Ferramenta de definição de esquema XML (Xsd.exe)

A ferramenta XML Schema Definition (Xsd.exe) gera classes de esquema XML ou common language runtime a partir de arquivos XDR, XML e XSD ou de classes em um assembly de tempo de execução.

A ferramenta de definição de esquema XML (Xsd.exe) geralmente pode ser encontrada no seguinte caminho:
C:\Arquivos de Programas (x86)\Microsoft SDKs\Windows\{version}\bin\NETFX {version} Tools\

Sintaxe

Execute a ferramenta a partir da linha de comando.

xsd file.xdr [-outputdir:directory][/parameters:file.xml]
xsd file.xml [-outputdir:directory] [/parameters:file.xml]
xsd file.xsd {/classes | /dataset} [/element:element]
             [/enableLinqDataSet] [/language:language]
                          [/namespace:namespace] [-outputdir:directory] [URI:uri]
                          [/parameters:file.xml]
xsd {file.dll | file.exe} [-outputdir:directory] [/type:typename [...]][/parameters:file.xml]

Argumento

Opções Gerais

Opções de arquivo XSD

Você deve especificar apenas uma das seguintes opções para arquivos .xsd.

Você também pode especificar qualquer uma das seguintes opções para arquivos .xsd.

Opções de arquivo DLL e EXE

Observações

A tabela a seguir mostra as operações que Xsd.exe executa.

Xsd.exe só permite manipular esquemas XML que seguem a linguagem XSD (XML Schema Definition) proposta pelo World Wide Web Consortium (W3C). Para obter mais informações sobre a proposta de definição de esquema XML ou o padrão XML, consulte https://w3.org.

Definindo opções com um arquivo XML

Usando a /parameters opção, você pode especificar um único arquivo XML que define várias opções. As opções que você pode definir dependem de como você está usando a ferramenta XSD.exe. As opções incluem gerar esquemas, gerar arquivos de código ou gerar arquivos de código que incluem DataSet recursos. Por exemplo, você pode definir o <assembly> elemento como o nome de um arquivo executável (.exe) ou biblioteca de tipos (.dll) ao gerar um esquema, mas não ao gerar um arquivo de código. O XML a seguir mostra como usar o <generateSchemas> elemento com um executável especificado:

<!-- This is in a file named GenerateSchemas.xml. -->
<xsd xmlns='http://microsoft.com/dotnet/tools/xsd/'>
<generateSchemas>
   <assembly>ConsoleApplication1.exe</assembly>
</generateSchemas>
</xsd>

Se o XML anterior estiver contido em um arquivo chamado GenerateSchemas.xml, use a /parameters opção digitando o seguinte em um prompt de comando e pressionando Enter:

 xsd /p:GenerateSchemas.xml

Por outro lado, se você estiver gerando um esquema para um único tipo encontrado no assembly, poderá usar o seguinte XML:

<!-- This is in a file named GenerateSchemaFromType.xml. -->
<xsd xmlns='http://microsoft.com/dotnet/tools/xsd/'>
<generateSchemas>
   <type>IDItems</type>
</generateSchemas>
</xsd>

Mas para usar o código anterior, você também deve fornecer o nome do assembly no prompt de comando. Digite o seguinte em um prompt de comando (presumindo que o arquivo XML tenha o nome GenerateSchemaFromType.xml):

xsd /p:GenerateSchemaFromType.xml ConsoleApplication1.exe

Você deve especificar apenas uma das seguintes opções para o <generateSchemas> elemento .

Para gerar um arquivo de código, use o <generateClasses> elemento . O exemplo a seguir gera um arquivo de código. Observe que dois atributos também são mostrados que permitem definir a linguagem de programação e o namespace do arquivo gerado.

<xsd xmlns='http://microsoft.com/dotnet/tools/xsd/'>
<generateClasses language='VB' namespace='Microsoft.Serialization.Examples'/>
</xsd>
<!-- You must supply an .xsd file when typing in the command line.-->
<!-- For example: xsd /p:genClasses mySchema.xsd -->

As opções que você pode definir para o <generateClasses> elemento incluem o seguinte.

A tabela a seguir mostra os atributos que também podem ser usados com o <generateClasses> elemento .

Você também pode controlar como DataSet o código é gerado usando o <generateDataSet> elemento . O XML a seguir especifica que o código gerado usa DataSet estruturas (como a DataTable classe) para criar código do Visual Basic para um elemento especificado. As estruturas DataSet geradas suportarão consultas LINQ.

<xsd xmlns='http://microsoft.com/dotnet/tools/xsd/'>
    <generateDataSet language='VB' namespace='Microsoft.Serialization.Examples' enableLinqDataSet='true'>
    </generateDataSet>
</xsd>

As opções que você pode definir para o <generateDataSet> elemento incluem o seguinte.

A tabela a seguir mostra os atributos que podem ser usados com o <generateDataSet> elemento .

Há atributos que você pode definir no elemento de nível <xsd> superior. Essas opções podem ser usadas com qualquer um dos elementos filho (<generateSchemas>, <generateClasses> ou <generateDataSet>). O código XML a seguir gera código para um elemento chamado "IDItems" no diretório de saída chamado "MyOutputDirectory".

<xsd xmlns='http://microsoft.com/dotnet/tools/xsd/' output='MyOutputDirectory'>
<generateClasses>
    <element>IDItems</element>
</generateClasses>
</xsd>

A tabela a seguir mostra os atributos que também podem ser usados com o <xsd> elemento .

Exemplos

O comando a seguir gera um esquema XML e myFile.xdr o salva no diretório atual.

xsd myFile.xdr

O comando a seguir gera um esquema XML e myFile.xml o salva no diretório especificado.

xsd myFile.xml /outputdir:myOutputDir

O comando a seguir gera um conjunto de dados que corresponde ao esquema especificado na linguagem C# e o salva como XSDSchemaFile.cs no diretório atual.

xsd /dataset /language:CS XSDSchemaFile.xsd

O comando a seguir gera esquemas XML para todos os tipos no assembly myAssembly.dll e os salva como schema0.xsd no diretório atual.

xsd myAssembly.dll

Consulte também

• DataSet
• System.Xml.Serialization.XmlSerializer
• Ferramentas
• Shells de linha de comando do desenvolvedor
• Visão geral do LINQ to DataSet
• Consultando conjuntos de dados tipados
• LINQ (consulta integrada à linguagem) (C#)
• LINQ (Consulta integrada à linguagem) (Visual Basic)