Note
The enumerator of the returned collection does not support the IEnumerator.Reset method.
KGy SOFT Core Libraries Help
EnumTEnumGet
Gets an IEnumerableT enumeration of flags,
where each flags are returned as distinct values.
Definition
Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
A lazy-enumerated IEnumerableT instance containing each flags of flags as distinct values.
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1
C#
public static IEnumerable<TEnum> GetFlags(
TEnum flags,
bool onlyDefinedValues = false
)VB
Public Shared Function GetFlags (
flags As TEnum,
Optional onlyDefinedValues As Boolean = false
) As IEnumerable(Of TEnum)C++
public:
static IEnumerable<TEnum>^ GetFlags(
TEnum flags,
bool onlyDefinedValues = false
)F#
static member GetFlags :
flags : 'TEnum *
?onlyDefinedValues : bool
(* Defaults:
let _onlyDefinedValues = defaultArg onlyDefinedValues false
*)
-> IEnumerable<'TEnum> Parameters
- flags TEnum
- A flags enum value, whose flags should be returned. It is not checked whether TEnum is really marked by FlagsAttribute.
- onlyDefinedValues Boolean (Optional)
- to return only flags that are defined in TEnum;
to return also undefined flags. This parameter is optional.
Default value: .
Return Value
IEnumerableTEnumA lazy-enumerated IEnumerableT instance containing each flags of flags as distinct values.