The Description property returns or sets the textual description of a Data Transformation Services (DTS) object.
object.Description [= value]
| Part | Description |
|---|---|
| object | Expression that evaluates to an object in the Applies To list |
| value | Description of the associated object |
String
Varies
HRESULT GetDescription(BSTR *pRetVal);
HRESULT SetDescription(BSTR NewValue);
Description is usually a read/write property. However, it is a read-only property of informational objects such as the OLEDBProviderInfo, PackageInfo, SavedPackageInfo, ScriptingLangaugeInfo, TaskInfo and TransformationInfo objects.
When the associated object is a DTS class-specific task object, the Description property also can be referenced through the Properties collection of the Task object with the following code:
Set taskprops = task.Properties
taskprops("Description") [= value]