IEventTrigger::ValueQueries property

Gets or sets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from the subscription query specified in the Subscription property.

This property is read/write.

Syntax


HRESULT put_ValueQueries(
  [in]  ITaskNamedValueCollection *pNamedXPaths
);

HRESULT get_ValueQueries(
  [out] ITaskNamedValueCollection **ppNamedXPaths
);

Property value

A pointer to collection of name-value pairs. Each name-value pair in the collection defines a unique name for a property value of the event that triggers the event trigger. The property value of the event is defined as an XPath event query. For more information about XPath event queries, see Event Selection.

Error codes

NameMeaning
S_OK

The property value was successfully set or retrieved.

Remarks

The name of the query can be used as a variable in the following action properties:

The following code example strings show two name-value pairs that can be used in a name-value collection. The values returned by the XPath queries can replace variables in an action property. The values are referenced by name, with $(user) and $(machine), in the action property. For example, if the $(user) and $(machine) variables are used in the MessageBody property of IShowMessageAction, then the value of the XPath queries will replace the variables in the string.

name: user
value: Event/UserData/SubjectUserName

name: machine
value: Event/UserData/MachineName

For more information about writing a query string for certain events, see Event Selection and Subscribing to Events.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Taskschd.h

Library

Taskschd.lib

DLL

Taskschd.dll

See also

IEventTrigger
ITaskNamedValueCollection
ITaskNamedValuePair

 

 

Show: