Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IDTSFriendlyEnumCollection100 Interface

Contains a collection of IDTSFriendlyEnum100 objects.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)
[GuidAttribute("62A4A8D8-3B64-4EB0-BA77-6AE679985259")]
public interface IDTSFriendlyEnumCollection100 : IEnumerable

The IDTSFriendlyEnumCollection100 type exposes the following members.

  NameDescription
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.
Top
  NameDescription
Public methodGetEnumeratorReturns an IEnumerator that can iterate through an IDTSFriendlyEnumCollection100.
Top

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.

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

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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.