Share via

_DTSCatalogImport::get_Description, put_Description Property [C++]

  • Article

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

Definition

[C++]

Get method:

HRESULT _DTSCatalogImport::get_Description(
BSTR Description
);

Put method:

HRESULT _DTSCatalogImport::put_Description(
BSTR Description
);

[Visual Basic]

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.

None.[Visual Basic]

[C++]

Return Values

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

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

Scripting the Product Catalog Import DTS Task

[C++]DTSCatalogImport::CustomTask_Execute

[C++]DTSCatalogImport::get_NumRetries, put_NumRetries

[C++]DTSCatalogImport::PersistPropertyBag_Load

[C++]DTSCatalogImport::PersistPropertyBag_Save

[C++]DTSCatalogImport::get_ProcessingType, put_ProcessingType

[C++]DTSCatalogImport::get_RetryInterval, put_RetryInterval

[C++]DTSCatalogImport::put_SourceName

[C++]DTSCatalogImport::get_SourceType, put_SourceType

[Visual Basic]DTSCatalogImport.CustomTask_Execute

[Visual Basic]DTSCatalogImport.NumRetries

[Visual Basic]DTSCatalogImport.PersistPropertyBag_Load

[Visual Basic]DTSCatalogImport.PersistPropertyBag_Save

[Visual Basic]DTSCatalogImport.ProcessingType

[Visual Basic]DTSCatalogImport.RetryInterval

[Visual Basic]DTSCatalogImport.SourceName

[Visual Basic]DTSCatalogImport.SourceType

Copyright © 2005 Microsoft Corporation.
All rights reserved.