Share via


_DTSCatalogImport::get_Description, put_Description Property

The Description property is a read/write String that describes the Data Transformation Services (DTS) task.

HRESULT _DTSCatalogImport::get_Description(
 BSTR Description
);
HRESULT _DTSCatalogImport::put_Description(
 BSTR Description
);
Property Description() As String

Parameters

  • Description
    [C++]

    [in] When putting the property, a BSTR used to describe the DTS task. [out,retval] When getting the property, a BSTR used to describe the DTS task.

Return Value

[C++]

These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

[Visual Basic]

None.

Error Values

[C++]

These methods return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic]

This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

See Also

Other Resources

_DTSCatalogImport::CustomTask_Execute Method

_DTSCatalogImport::get_NumRetries, put_NumRetries Property

_DTSCatalogImport::PersistPropertyBag_Load Method

_DTSCatalogImport::PersistPropertyBag_Save Method

_DTSCatalogImport::get_ProcessingType, put_ProcessingType Property

_DTSCatalogImport::get_RetryInterval, put_RetryInterval Property

_DTSCatalogImport::put_SourceName Property

_DTSCatalogImport::get_SourceType, put_SourceType Property