IRegistrationInfo::Documentation property

Gets or sets any additional documentation for the task.

This property is read/write.

Syntax


HRESULT put_Documentation(
  [in]  BSTR documentation
);

HRESULT get_Documentation(
  [out] BSTR *pDocumentation
);

Property value

Any additional documentation that is associated with 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 additional documentation for the task is specified using the Documentation 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

 

 

Show: