XmlPeek Class

Definition

A task that returns values as specified by XPath Query from an XML file.

public ref class XmlPeek : Microsoft::Build::Tasks::TaskExtension
public class XmlPeek : Microsoft.Build.Tasks.TaskExtension
type XmlPeek = class
    inherit TaskExtension
Public Class XmlPeek
Inherits TaskExtension
Inheritance

Constructors

XmlPeek()

Creates a task that returns values as specified by XPath Query from an XML file.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Retrieves the IBuildEngine7 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine8

Retrieves the IBuildEngine8 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine9

Retrieves the IBuildEngine9 version of the build engine interface provided by the host.

(Inherited from Task)
HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
Namespaces

The namespaces for XPath query's prefixes.

ProhibitDtd

Set to true to prohibit loading XML with embedded DTD and produce error MSB3733 if DTD is present. This was a pre-v15 behavior. By default, a DTD clause if any is ignored.

Query

The XPath Query.

Result

The results returned by this task.

TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)
XmlContent

The XML input as a string.

XmlInputPath

The XML input as a file path.

Methods

Execute()

Executes the XMLPeek task.

Applies to