IDataCollectorSet::TaskArguments property

Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IDataCollectorSet::Task property.

This property is read/write.

Syntax


HRESULT put_TaskArguments(
  BSTR Task
);

HRESULT get_TaskArguments(
  BSTR *pTask
);

Property value

The command-line arguments to pass to the Task Scheduler job. For more details, see Remarks.

Error codes

Returns S_OK if successful.

Remarks

PLA provides the following substitution variables that you can include in your arguments string. PLA provides the values for the substitution variables when the task is triggered. You must escape the braces, for example, \{name\}.

VariableDescription
{key}Space-delimited list of key values that were specified using the IDataCollectorSet::SetValue method.
{logs}Space-delimited list of full paths to the current data collector files.
{state}Indicates whether the set is running (1 for running, 0 for stopped).
{usertext}String from the IDataCollectorSet::TaskUserTextArguments property.

 

Typically, if you use the substitution variables, you specify them in TaskUserTextArguments, where you do not have to escape the braces and then specify {usertext} in this property.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Pla.h

DLL

Pla.dll

See also

IDataCollectorSet
IDataCollectorSet::Task
IDataCollectorSet::TaskUserTextArguments

 

 

Community Additions

ADD
Show:
© 2014 Microsoft