IDTSFriendlyEnum100 Interface
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
<GuidAttribute("0EC4EFFF-DDE2-4637-A091-2BAAF3B24197")> _
Public Interface IDTSFriendlyEnum100
'Usage
Dim instance As IDTSFriendlyEnum100
[GuidAttribute("0EC4EFFF-DDE2-4637-A091-2BAAF3B24197")]
public interface IDTSFriendlyEnum100
[GuidAttribute(L"0EC4EFFF-DDE2-4637-A091-2BAAF3B24197")]
public interface class IDTSFriendlyEnum100
[<GuidAttribute("0EC4EFFF-DDE2-4637-A091-2BAAF3B24197")>]
type IDTSFriendlyEnum100 = interface end
public interface IDTSFriendlyEnum100
The IDTSFriendlyEnum100 type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Name | Gets the name of a value in an enumeration. |
|
Value | Gets the friendly name used for an enumeration item identified by the Name property. |
Top
Remarks
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.