IRegistrationInfo::Description property

Gets or sets the description of the task.

This property is read/write.

Syntax


HRESULT put_Description(
  [in]   BSTR description
);

HRESULT get_Description(
  [out]  BSTR *pDescription
);

Property value

The description of the task.

Error codes

NameMeaning
S_OK

The property value was successfully set or retrieved.

Remarks

When reading or writing XML for a task, the description of the task is specified using the Description element of the Task Scheduler schema.

When setting this property value, the value can be text that is retrieved from a resource .dll file. A specialized string is used to reference the text from the resource file. The format of the string is $(@ [Dll], [ResourceID]) where [Dll] is the path to the .dll file that contains the resource and [ResourceID] is the identifier for the resource text. For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file.

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

IRegistrationInfo
Task Scheduler

 

 

Community Additions

ADD
Show:
© 2014 Microsoft