XPathResult.xml

<Type Name="XPathResult" FullName="System.ServiceModel.Dispatcher.XPathResult">
  <TypeSignature Language="C#" Value="public sealed class XPathResult : IDisposable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit XPathResult extends System.Object implements class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:System.ServiceModel.Dispatcher.XPathResult" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class XPathResult&#xA;Implements IDisposable" />
  <TypeSignature Language="F#" Value="type XPathResult = class&#xA;    interface IDisposable" />
  <TypeSignature Language="C++ CLI" Value="public ref class XPathResult sealed : IDisposable" />
  <AssemblyInfo>
    <AssemblyName>System.ServiceModel</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <summary>Contains the value returned by an XPath query.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following example creates a message and XPath message queries. The queries are evaluated by the <xref:System.ServiceModel.XPathMessageQuery> objects contained in an <xref:System.ServiceModel.Dispatcher.XPathMessageQueryCollection> object. The results of each query are tested using the <xref:System.ServiceModel.Dispatcher.XPathResult.ResultType%2A> property of the <xref:System.ServiceModel.Dispatcher.XPathResult> class.  
  
 :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/xpathmessagequery/cs/source.cs" id="Snippet0":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xpathmessagequery/vb/source.vb" id="Snippet0":::  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.XPathResult.Dispose" />
      <MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="xPathResult.Dispose " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Dispose();" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Releases all resources owed by the object.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetResultAsBoolean">
      <MemberSignature Language="C#" Value="public bool GetResultAsBoolean ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool GetResultAsBoolean() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.XPathResult.GetResultAsBoolean" />
      <MemberSignature Language="VB.NET" Value="Public Function GetResultAsBoolean () As Boolean" />
      <MemberSignature Language="F#" Value="member this.GetResultAsBoolean : unit -&gt; bool" Usage="xPathResult.GetResultAsBoolean " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; bool GetResultAsBoolean();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the result of the XPath query as a Boolean value.</summary>
        <returns>
          <see cref="T:System.Boolean" />
        </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetResultAsNodeset">
      <MemberSignature Language="C#" Value="public System.Xml.XPath.XPathNodeIterator GetResultAsNodeset ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Xml.XPath.XPathNodeIterator GetResultAsNodeset() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.XPathResult.GetResultAsNodeset" />
      <MemberSignature Language="VB.NET" Value="Public Function GetResultAsNodeset () As XPathNodeIterator" />
      <MemberSignature Language="F#" Value="member this.GetResultAsNodeset : unit -&gt; System.Xml.XPath.XPathNodeIterator" Usage="xPathResult.GetResultAsNodeset " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Xml::XPath::XPathNodeIterator ^ GetResultAsNodeset();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Xml.XPath.XPathNodeIterator</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the result of the XPath query as an enumerable set of nodes.</summary>
        <returns>
          <see cref="T:System.Xml.XPath.XPathNodeIterator" />  
  
 A collection of XPath nodes that can be iterated over.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Use the <xref:System.Xml.XPath.XPathNodeIterator.MoveNext%2A> method of the <xref:System.Xml.XPath.XPathNodeIterator> class within a loop to see the value of each node.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetResultAsNumber">
      <MemberSignature Language="C#" Value="public double GetResultAsNumber ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float64 GetResultAsNumber() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.XPathResult.GetResultAsNumber" />
      <MemberSignature Language="VB.NET" Value="Public Function GetResultAsNumber () As Double" />
      <MemberSignature Language="F#" Value="member this.GetResultAsNumber : unit -&gt; double" Usage="xPathResult.GetResultAsNumber " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; double GetResultAsNumber();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the result of the XPath query as a number.</summary>
        <returns>
          <see cref="T:System.Double" />
        </returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetResultAsString">
      <MemberSignature Language="C#" Value="public string GetResultAsString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetResultAsString() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Dispatcher.XPathResult.GetResultAsString" />
      <MemberSignature Language="VB.NET" Value="Public Function GetResultAsString () As String" />
      <MemberSignature Language="F#" Value="member this.GetResultAsString : unit -&gt; string" Usage="xPathResult.GetResultAsString " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::String ^ GetResultAsString();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the result of the XPath query as a string.</summary>
        <returns>Returns <see cref="T:System.String" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResultType">
      <MemberSignature Language="C#" Value="public System.Xml.XPath.XPathResultType ResultType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Xml.XPath.XPathResultType ResultType" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.Dispatcher.XPathResult.ResultType" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ResultType As XPathResultType" />
      <MemberSignature Language="F#" Value="member this.ResultType : System.Xml.XPath.XPathResultType" Usage="System.ServiceModel.Dispatcher.XPathResult.ResultType" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Xml::XPath::XPathResultType ResultType { System::Xml::XPath::XPathResultType get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Xml.XPath.XPathResultType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the type of the value returned by the XPath query.</summary>
        <value>
          <see cref="T:System.Xml.XPath.XPathResultType" />  
  
 One of the enumeration values. To get the actual result, use the corresponding method. For example, if the value is <see cref="F:System.Xml.XPath.XPathResultType.Number" />, use the <see cref="M:System.ServiceModel.Dispatcher.XPathResult.GetResultAsNumber" /> method.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>