Skip to content

Latest commit

 

History

History
101 lines (83 loc) · 4.25 KB

nf-pla-idatacollectorset-put_taskarguments.md

File metadata and controls

101 lines (83 loc) · 4.25 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:pla.IDataCollectorSet.put_TaskArguments
IDataCollectorSet::put_TaskArguments (pla.h)
Retrieves or sets the command-line arguments to pass to the Task Scheduler job specified in the IDataCollectorSet::Task property. (Put)
IDataCollectorSet interface [PLA]
TaskArguments property
IDataCollectorSet.TaskArguments
IDataCollectorSet.put_TaskArguments
IDataCollectorSet::TaskArguments
IDataCollectorSet::get_TaskArguments
IDataCollectorSet::put_TaskArguments
TaskArguments property [PLA]
TaskArguments property [PLA]
IDataCollectorSet interface
base.idatacollectorset_get_taskarguments
pla.idatacollectorset_get_taskarguments
pla/IDataCollectorSet::TaskArguments
pla/IDataCollectorSet::get_TaskArguments
pla/IDataCollectorSet::put_TaskArguments
put_TaskArguments
pla\idatacollectorset_get_taskarguments.htm
PLA
7bd045df-379b-40fb-b309-cec531493018
12/05/2018
IDataCollectorSet interface [PLA],TaskArguments property, IDataCollectorSet.TaskArguments, IDataCollectorSet.put_TaskArguments, IDataCollectorSet::TaskArguments, IDataCollectorSet::get_TaskArguments, IDataCollectorSet::put_TaskArguments, TaskArguments property [PLA], TaskArguments property [PLA],IDataCollectorSet interface, base.idatacollectorset_get_taskarguments, pla.idatacollectorset_get_taskarguments, pla/IDataCollectorSet::TaskArguments, pla/IDataCollectorSet::get_TaskArguments, pla/IDataCollectorSet::put_TaskArguments, put_TaskArguments
pla.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Pla.dll
Windows
19H1
IDataCollectorSet::put_TaskArguments
pla/IDataCollectorSet::put_TaskArguments
c++
APIRef
kbSyntax
COM
Pla.dll
IDataCollectorSet.TaskArguments
IDataCollectorSet.get_TaskArguments
IDataCollectorSet.put_TaskArguments

IDataCollectorSet::put_TaskArguments

-description

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.

-parameters

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

-see-also

IDataCollectorSet

IDataCollectorSet::Task

IDataCollectorSet::TaskUserTextArguments