Attività XmlPeek

  • Articolo

Restituisce valori come specificato dalla query XPath da un file XML.

Parametri

Nella tabella che segue vengono descritti i parametri dell'attività XmlPeek.

Parametro Descrizione
Namespaces Parametro String facoltativo.

Specifica gli spazi dei nomi per i prefissi della query XPath.
Query Parametro String facoltativo.

Specifica la query XPath.
Result Parametro di output ITaskItem[] facoltativo.

Contiene i risultati restituiti da questa attività.
XmlContent Parametro String facoltativo.

Specifica l'input XML sotto forma di stringa.
XmlInputPath Parametro ITaskItem facoltativo.

Specifica l'input XML come percorso di file.

Osservazioni:

Oltre a usare i parametri elencati nella tabella, questa attività eredita i parametri dalla classe TaskExtension che a sua volta eredita dalla classe Task. Per un elenco di questi parametri aggiuntivi e le rispettive descrizioni, vedere TaskExtension Base Class.

Esempio

Ecco un file settings.config XML di esempio da leggere:

<appSettings>
  <add key="ProjectFolder" value="S1" />
</appSettings>

In questo esempio, se si vuole leggere value, usare codice simile al seguente:

<Target Name="BeforeBuild">
    <XmlPeek XmlInputPath="settings.config" Query="appSettings/add[@key='ProjectFolder']/@value">
        <Output TaskParameter="Result" ItemName="value" />
    </XmlPeek>
    <Message Text="Using project folder @(value)." Importance="high" />
    <PropertyGroup>
        <ProjectFolder>@(value)</ProjectFolder>
    </PropertyGroup>
    <ItemGroup>
        <Compile Include="Projects\$(ProjectFolder)\Controls\Control1.ascx.cs">
            <SubType>ASPXCodeBehind</SubType>
        </Compile>
    </ItemGroup>
</Target>

Con gli spazi dei nomi XML, usare il Namespaces parametro , come nell'esempio seguente. Con il file XMLFile1.xmlXML di input :

<?xml version="1.0" encoding="UTF-8"?>
<class AccessModifier='public' Name='test' xmlns:s='http://nsurl'>
  <s:variable Type='String' Name='a'>This</s:variable>
  <s:variable Type='String' Name='b'>is</s:variable>
  <s:variable Type='String' Name='c'>Sparta!</s:variable>
  <method AccessModifier='public static' Name='GetVal' />
</class>

E il codice seguente Target definito in un file di progetto:

  <Target Name="TestPeek" BeforeTargets="Build">
    <!-- Find the Name attributes -->
    <XmlPeek XmlInputPath="XMLFile1.xml"
             Query="//s:variable/@Name"
             Namespaces="&lt;Namespace Prefix='s' Uri='http://nsurl' /&gt;">
      <Output TaskParameter="Result" ItemName="value1" />
    </XmlPeek>
    <Message Text="@(value1)"/>
    <!-- Find 'variable' nodes (XPath query includes ".") -->
    <XmlPeek XmlInputPath="XMLFile1.xml"
             Query="//s:variable/."
             Namespaces="&lt;Namespace Prefix='s' Uri='http://nsurl' /&gt;">
      <Output TaskParameter="Result" ItemName="value2" />
    </XmlPeek>
    <Message Text="@(value2)"/>
  </Target>

L'output include quanto segue dalla TestPeek destinazione:

  TestPeek output:
  a;b;c
  <s:variable Type="String" Name="a" xmlns:s="http://nsurl">This</s:variable>;<s:variable Type="String" Name="b" xmlns:s="http://nsurl">is</s:variable>;<s:variable Type="String" Name="c" xmlns:s="http://nsurl">Sparta!</s:variable>

Vedi anche