IDTSFriendlyEnum90 Interface

Article
12/03/2008

Provides names for the values of an enumeration.

Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in microsoft.sqlserver.dtspipelinewrap.dll)

Syntax

'Declaration
<TypeLibTypeAttribute(4160)> _
<GuidAttribute("32870502-FA13-4B2D-93D9-2F3A017DF045")> _
Public Interface IDTSFriendlyEnum90

[TypeLibTypeAttribute(4160)] 
[GuidAttribute("32870502-FA13-4B2D-93D9-2F3A017DF045")] 
public interface IDTSFriendlyEnum90

[TypeLibTypeAttribute(4160)] 
[GuidAttribute(L"32870502-FA13-4B2D-93D9-2F3A017DF045")] 
public interface class IDTSFriendlyEnum90

/** @attribute TypeLibTypeAttribute(4160) */ 
/** @attribute GuidAttribute("32870502-FA13-4B2D-93D9-2F3A017DF045") */ 
public interface IDTSFriendlyEnum90

TypeLibTypeAttribute(4160) 
GuidAttribute("32870502-FA13-4B2D-93D9-2F3A017DF045") 
public interface IDTSFriendlyEnum90

Remarks

The IDTSFriendlyEnum90 interface is a helper interface used by native C++ component developers to expose "friendly names" for the value of an item in an enumeration. The IDTSFriendlyEnum90 and IDTSFriendlyEnumCollection90 are used in combination with the following macros to provide friendly names for the values of an enumeration in DTS designer.

Macro	Description
BEGIN_FRIENDLY_NAME_ENUM_LIST	Starts the friendly name enumeration list.
BEGIN_FRIENDLY_NAME_ENUM( EnumerationName, IsFlags)	Starts a friendly name enumeration list block. This is specified once for each enumeration. The EnumerationName parameter specifies the name of the enumeration and the IsFlags parameter specifies whether the values in the enumeration can be ORed together.
FRIENDLY_NAME(Value, NameID)	Adds a friendly name for a specific value in the enumeration specified in the BEGIN_FRIENDLY_NAME_ENUM. The Value parameter specifies the item in the enumeration and the NameID parameter specifies the string that is displayed for the enumeration value.
END_FRIENDLY_NAME_ENUM	Indicates the end of the friendly enumeration; specified once for each BEGIN_FRIENDLY_ENUM macro.
END_FRIENDLY_ENUM_LIST	Ends the friendly enumeration name list.

After defining a friendly enumeration using the macros listed above, the TypeConverter property of the IDTSCustomProperty90 object is assigned the value of the EnumerationName parameter specified in the BEGIN_FRIENDLY_NAME_ENUM macro.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms