Click or drag to resize

EnumExtensionsGetEnumValueOrDefaultT(Object, Object) Method

Gets the enumeration constant for this value, if defined in the enumeration, or a default value.

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.205-beta+5ef4169f3b1079d8b163dd363614f656bd140924
Syntax
public static T GetEnumValueOrDefault<T>(
	this Object value,
	Object defaultValue = null
)
View Source

Parameters

value  Object
Value to attempt to return from enumeration.
defaultValue  Object  (Optional)
Value to return if enumeration value is not found.

Type Parameters

T
Type of enumeration.

Return Value

T
Enumeration value specified, if found, or a default value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Object. 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
ArgumentNullExceptionvalue is null.
ArgumentExceptionT is not an enum. -or- The type of value is not of type T. -or- The type of value is not an underlying type of T.
InvalidOperationExceptionvalue is not type SByte, Int16, Int32, Int64, Byte, UInt16, UInt32, or UInt64, or String.
Remarks
If a default value is not defined, first enumeration value will be used.
See Also