Share via


_DTSUPMCustomTask::get_DTSTaskDescription, put_DTSTaskDescription Property

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

The DTSTaskDescription property is a String that contains the description of the Data Transformation Services (DTS) task.

HRESULT _DTSUPMCustomTask::get_DTSTaskDescription( 
  BSTR DTSTaskDescription
);
HRESULT _DTSUPMCustomTask::put_DTSTaskDescription(
  BSTR DTSTaskDescription
);
Property DTSTaskDescription() As String

Parameters

  • DTSTaskDescription
    [C++]

    [in] When putting the property, a BSTR that contains the description of the DTS task.

    [out, retval] When getting the property, a BSTR that contains the description of the DTS task.

Return Value

[C++]

This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic]

None.

Error Values

[C++]

This method returns 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 method 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

_DTSUPMCustomtask::CustomTask_Execute

_DTSUPMCustomTask::get_DTSTaskImportStartDate, put_DTSTaskImportStartDate

_DTSUPMCustomTask::get_DTSTaskName, put_DTSTaskName

_DTSUPMCustomTask::get_DTSTaskTimeQuantum, put_DTSTaskTimeQuantum

_DTSUPMCustomTask::get_NumRetries, put_NumRetries

_DTSUPMCustomTask::get_ProcessingType, put_ProcessingType

_DTSUPMCustomTask::get_RetryInterval, put_RetryInterval

_DTSUPMCustomTask::get_SourceName, put_SourceName

_DTSUPMCustomTask::get_SourceType, put_SourceType