IDTSDataPumpTransform2::GetTransformServerInfo
The GetTransformServerInfo method returns information that describes the functionality of the transformation.
Syntax
HRESULT GetTransformServerInfo (
BSTR *pbstrHelpString,
LPDTSTransformPhaseEnum peSupportedPhases );
| Argument | Description |
|---|---|
| pbstrHelpString [out] | Description of the transformation implementation |
| peSupportedPhases [out] | Phases supported by this transformation |
Remarks
This method is called before IDTSDataPumpTransform::Initialize. It returns a textual description that can be used as a help string and a bitmask that contains flags for the supported phases. These flags are values from DTSTransformPhaseEnum.
Any output parameter can be NULL if that information is not desired by the caller. GetTransformServerInfo must be prepared to handle these.
IDTSDataPumpTransform2::ProcessPhase is not called for a phase specified by GetTransformServerInfo unless the value specified for the TransformPhases property of the Transformation2 object also specifies the phase. For packages built in Data Transformation Services (DTS) Designer, specify phases on the Phases tab of the Transformation Options dialog box.
See Also
IDTSDataPumpTransform::Initialize
IDTSDataPumpTransform::OnTransformComplete