IDataCollectorSet::get_Description method (pla.h)
Retrieves or sets the description of the data collector set. The description will be added to all output files as metadata and inserted into Performance Data Helper logs as a comment.
This property is read/write.
Syntax
HRESULT get_Description(
BSTR *description
);
Parameters
description
Return value
None
Remarks
To use a localized string from a binary, specify the description in the form @binary,#id where binary is the EXE or DLL that contains the localized resource string and id is the string resource identifier.
If you set the description to the @binary,#id form, when you retrieve the description you will receive the localized string. To retrieve the description string that you set, access the IDataCollectorSet::DescriptionUnresolved property.
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 |