ITriggerCollection::Remove method (taskschd.h)

Article
02/22/2024

Removes the specified trigger from the collection of triggers used by the task.

Syntax

HRESULT Remove(
  [in] VARIANT index
);

Parameters

[in] index

The index of the trigger to be removed. Use a LONG value for the index number.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

When removing items, note that the index for the first item in the collection is 1 and the index for the last item is the value of the Count property.

This method will return E_INVALIDARG when the value passed to the index parameter is not valid.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	taskschd.h
Library	Taskschd.lib
DLL	Taskschd.dll