Use XSD Build task in c# project

5
votes

How can I use the c++ XSD Task in a c# project? I have already created the task in the csproj file like this:

  <Target Name="BeforeBuild">
    <XSD Namespace="$(RootNamespace).Xml" Language="CS" GenerateFromSchema="classes" Sources="Xml/schema.xsd" />
  </Target>

but the build output says, although intellisense offers me the XSD task while editing the project file:

Error   1   The "XSD" task was not found. Check the following: 
1.) The name of the task in the project file is the same as the name of the task class. 
2.) The task class is "public" and implements the Microsoft.Build.Framework.ITask interface. 3.) The task is correctly declared with <UsingTask> in the project file, or in the *.tasks files located in the "C:\Windows\Microsoft.NET\Framework\v4.0.30128" directory. MyProject.csproj

Oh, and I am using Visual Studio 2010 RC.

*

5
c#visual-studio-2010msbuildmsbuild-task
Forget the C++ bit, it's a distraction from the msdn page title. The tool is called XML Schema Definition Tool (Xsd.exe), and its for creating schema or code. To debug further please set your msbuild logging level to /versbosity:diagnostic and see what headers (imported MSBUILD task definitions its pulling in). – Preet Sangha
I know about the xsd.exe tool. Right now I'm using it with a Exec task to do the job. I was just wondering if I a can somehow use the specific task that is already available (and according to msdn is a wrapper around xsd.exe).... – m0sa
Thats what I said. Run the diagnostics and see what tasks are loaded and where from. Then we can see if the correct task is actually loaded by MSBUILD or if isn't. – Preet Sangha
<br> Today you can use XSD2 nuget, without depedency on c++ toolset. <br> You don't need that at all as well as not the complexity of the abobe proposals. xsd2 github xsd2 nuget page – Meir Kriheli

5 Answers

4
votes

This is because the C++ targets are not imported. Because XSD is not one of the default tasks defined by the managed build process. you need to add a UsingTask to reference it. Add this to your csproj file:

<UsingTask TaskName="XSD" AssemblyName="Microsoft.Build.CppTasks.Common, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"/>

Good Luck, Jamie

4
votes

A slightly improved version/approach is to use the following in a common .targets file:

<!-- Establish the proper $(CPPTasks) location -->
<Choose>
  <When Condition=" '_$(VisualStudioVersion)'=='_11.0' " >
    <PropertyGroup>
        <CPPTasks>V110\Microsoft.Build.CPPTasks.Common.v110.dll</CPPTasks>
    </PropertyGroup>
  </When>
  <Otherwise>
    <PropertyGroup>
        <CPPTasks>Microsoft.Build.CPPTasks.Common.dll</CPPTasks>
    </PropertyGroup>
  </Otherwise>
</Choose>

Then in your .csproj you can do the following:

<UsingTask TaskName="XSD" AssemblyFile="$(VCTargetsPath)$(CPPTasks)" />

Note that this has been tested in VS2010, VS2011, VS2013 (DLL names switch back and forth depending on the version of VS installed. :(

The improvement is that only one place contains the logic for the proper DLL path and name rather than individual .csproj files.

2
votes

Got it to work with a slightly different syntax. This is using VS 2012 Update 4.

What worked: 

<UsingTask TaskName="XSD" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft.Cpp\v4.0\V110\Microsoft.Build.CPPTasks.Common.v110.dll" />
<Target Name="BeforeBuild">
    <Message Text="Generating serialization class(es)..." />
    <ItemGroup>
        <_SerializationFile Include="$(ProjectDir)My_Xsd_File.cs" />
    </ItemGroup>
    <XSD Condition="!Exists('@(_SerializationFile)')" GenerateFromSchema="classes" Language="CS" Namespace="$(RootNamespace)" Sources="My.Xsd.File.xsd" />
</Target>

I used the direct AssemblyFile attribute on UsingTask in my case. Note also that embedded . characters in the XSD name were converted to _ characters as well.

1
votes

Add this to your project file:

<UsingTask TaskName="XSD" AssemblyName="Microsoft.Build.CppTasks.Common, Version=4.0.0.0,         Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
 <Target Name="BeforeBuild">
  <XSD Sources="MySchema.xsd" GenerateFromSchema="classes" Language="CS">
  </XSD>
 </Target>

Please look the Question Using XSD task I'm getting MSB0001: Internal MSBuild Error: xsd.exe unexpectedly not a rooted path

And add the path of xsd.exe and Microsoft.Build.CppTasks.Common.dll to Environment Variable, restart my computer. It works fine again.

The path of xsd.exe and Microsoft.Build.CppTasks.Common.dll are:

C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin\NETFX 4.0 Tools\; C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0

Or you also can add following command line in your Pre-build event to achieve this:

xsd.exe /classes /language:CS MySchema.xsd
1
votes

It looks like the XSD MsBuild task has been deprecated since VS2017. The following target will call Xsd.exe using the Exec task before compile.

 <!--
      Executes the xsd.exe command on Filename.xsd.  If more XSD files
      are required, this target should be modified to find and generate 
      classes for all XSD classes, or alternatively use an MsBuild item
      to define which XSD files to use.
   -->
 <Target Name="Xsd" BeforeTargets="Compile" Inputs="Folder\Filename.xsd" Outputs="Folder\Filename.cs">
    <Message Importance="high" Text="Executing Xsd.exe on Folder\Filename.xsd"/>
    <!--
      Note the XSD msuild task is deprecated and removed.
      So execute the command using the Exec task.
     -->
    <Exec Command="&quot;$(SDK40ToolsPath)Xsd.exe&quot; /classes &quot;Folder\Filename.xsd&quot; -outputdir:Folder /namespace:Root.Folder"/>
  </Target>