ITrigger::Id property

Gets or sets the identifier for the trigger.

This property is read/write.

Syntax


HRESULT put_Id(
  [in]   BSTR id
);

HRESULT get_Id(
  [out]  BSTR *pId
);

Property value

The identifier for the trigger. This identifier is used by the Task Scheduler for logging purposes.

Error codes

NameMeaning
S_OK

The property value was successfully set or retrieved.

Remarks

When reading or writing XML for a task, the trigger identifier is specified in the Id attribute of the individual trigger elements (for example, the Id attribute of the BootTrigger element) of the Task Scheduler schema.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Taskschd.h

Library

Taskschd.lib

DLL

Taskschd.dll

See also

ITrigger
Task Scheduler

 

 

Community Additions

ADD
Show:
© 2014 Microsoft