EnumExtensionGetDescriptionTEnum Method

This method retrieves the description attribute value associated with the given enum value. If a description attribute is defined for the enum value, it returns the description value. Otherwise, it returns the string representation of the enum value.

Namespace: QsInformatica.Utils
Assembly: QsInformatica.Utils (in QsInformatica.Utils.dll) Version: 27.1.0

Syntax

C++

Copy

public static string GetDescription<TEnum>(
	this TEnum value
)

<ExtensionAttribute>
Public Shared Function GetDescription(Of TEnum) ( 
	value As TEnum
) As String

public:
[ExtensionAttribute]
generic<typename TEnum>
static String^ GetDescription(
	TEnum value
)

[<ExtensionAttribute>]
static member GetDescription : 
        value : 'TEnum -> string

Parameters

value TEnum: [Missing <param name="value"/> documentation for "M:QsInformatica.Utils.EnumExtension.GetDescription``1(``0)"]

Type Parameters

TEnum: [Missing <typeparam name="TEnum"/> documentation for "M:QsInformatica.Utils.EnumExtension.GetDescription``1(``0)"]

Return Value

String

[Missing <returns> documentation for "M:QsInformatica.Utils.EnumExtension.GetDescription``1(``0)"]

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type TEnum. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

EnumExtension Class

QsInformatica.Utils Namespace