Description Property

DTS Programming

DTS Programming
Syntax

object.Description [= value]

Part Description
object Expression that evaluates to an object in the Applies To list
value Description of the associated object

Data Type

String

Modifiable

Varies

Prototype (C/C++)

HRESULT GetDescription(BSTR *pRetVal);

HRESULT SetDescription(BSTR NewValue);

Remarks

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]

See Also

Name Property

Properties Collection

Task Object