Click or drag to resize

EnumExtensionsGetEnumValueByDescription Method

Gets the enumeration of the specified type whose description matches this description.

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.256-beta+0e7e94d39a9b10efe7e26e3b8d5130afc0dd4d74
Syntax
public static Object GetEnumValueByDescription(
	this string description,
	Type type,
	bool ignoreCase = false
)
View Source

Parameters

description  String
Description to be used for lookup of the enumeration.
type  Type
Type of the enumeration.
ignoreCase  Boolean  (Optional)
true to ignore case during the comparison; otherwise, false.

Return Value

Object
An enumeration of the specified type if a match is found, otherwise null.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type String. 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).
Exceptions
ExceptionCondition
ArgumentExceptionThe type is not an enumeration.
See Also