IDataCollectorSet::get_TaskArguments method (pla.h)

Article
02/22/2024

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 get_TaskArguments(
  BSTR *task
);

Parameters

task

Return value

None

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}.

Variable	Description
{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

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	pla.h
DLL	Pla.dll