Export (0) Print
Expand All

IDTSFriendlyEnumCollection100 Interface

Contains a collection of IDTSFriendlyEnum100 objects.

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

public interface IDTSFriendlyEnumCollection100 : IEnumerable

The IDTSFriendlyEnumCollection100 type exposes the following members.

Public propertyCountGets the number of elements contained in an IDTSFriendlyEnumCollection100 collection.
Public propertyIsFlagsGets a value that specifies whether the values of the IDTSFriendlyEnum100 objects in an IDTSFriendlyEnumCollection100 can be combined together.
Public propertyItemGets the IDTSFriendlyEnumCollection100 specified by the Index parameter.

Public methodGetEnumeratorReturns an IEnumerator that can iterate through an IDTSFriendlyEnumCollection100.

The IDTSFriendlyEnumCollection100 collection is a helper interface used by native C++ component developers to expose names for the values of an enumeration, when the enumeration is specified as the value of an IDTSCustomProperty100 object. The IDTSFriendlyEnumCollection100 and IDTSFriendlyEnum100 are used in combination with the following macros to provide friendly names for the values of an enumeration in DTS designer.




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.


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.


Indicates the end of the friendly enumeration; specified once for each BEGIN_FRIENDLY_ENUM macro.


End 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.

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

Community Additions

© 2015 Microsoft