Click or drag to resize

EnumExtensionsGetEnumValueOrDefault(Object, Type, Object) Method

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

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public static Object GetEnumValueOrDefault(
	this Object value,
	Type type,
	Object defaultValue = null
)
View Source

Parameters

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

Return Value

Object
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
ArgumentNullExceptiontype or value is null.
ArgumentExceptiontype is not an enum. -or- The type of value is not of type type. -or- The type of value is not an underlying type of type.
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