IDataCollectorSet::put_TaskUserTextArguments method (pla.h)
Retrieves or sets the command-line arguments that are substituted for the {usertext} substitution variable in the IDataCollectorSet::TaskArguments property.
This property is read/write.
Syntax
HRESULT put_TaskUserTextArguments(
BSTR UserText
);
Parameters
UserText
Return value
None
Remarks
These arguments are included in the command-line arguments passed to the Task Scheduler job only if the TaskArguments property includes the {usertext} substitution variable.
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 do not escape the braces.
| 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). |
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 |