Export (0) Print
Expand All

IDTSFriendlyEnum100 Interface

 

Applies To: SQL Server 2016 Preview

Provides names for the values of an enumeration.

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

[GuidAttribute("6B3E489C-E74F-4007-9764-7E6BD1EC6EE2")]
[TypeLibTypeAttribute(TypeLibTypeFlags.FDual | TypeLibTypeFlags.FDispatchable)]
public interface IDTSFriendlyEnum100

NameDescription
System_CAPS_pubpropertyName

Gets the name of a value in an enumeration.

System_CAPS_pubpropertyValue

Gets the friendly name used for an enumeration item identified by the Name property.

The IDTSFriendlyEnum100 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 IDTSFriendlyEnum100 and IDTSFriendlyEnumCollection100 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 IDTSCustomProperty100 object is assigned the value of the EnumerationName parameter specified in the BEGIN_FRIENDLY_NAME_ENUM macro.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft