Enum.GetValues メソッド

リファレンス

定義

名前空間:: System

アセンブリ:: System.Runtime.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

GetValues(Type)	指定した列挙体に含まれている定数の値の配列を取得します。
GetValues<TEnum>()	指定した列挙型に含まれている定数の値の配列を取得します。

GetValues(Type)

指定した列挙体に含まれている定数の値の配列を取得します。

public:
 static Array ^ GetValues(Type ^ enumType);

public static Array GetValues (Type enumType);

[System.Runtime.InteropServices.ComVisible(true)]
public static Array GetValues (Type enumType);

static member GetValues : Type -> Array

[<System.Runtime.InteropServices.ComVisible(true)>]
static member GetValues : Type -> Array

Public Shared Function GetValues (enumType As Type) As Array

パラメーター

enumType: Type

列挙型。

戻り値

Array

enumType に含まれている定数の値を格納する配列。

属性: ComVisibleAttribute

例外

ArgumentNullException

enumType が nullです。

ArgumentException

enumType が Enum ではありません。

InvalidOperationException

リフレクションのみのコンテキストでのリフレクションによって、メソッドが呼び出されます

- または -

enumType は、リフレクションのみのコンテキストで読み込まれたアセンブリに基づく型です。

InvalidOperationException

.NET 8 以降のバージョン: enumType は、ブール型に基づく列挙型です。

例

次の例は、GetValuesの使用方法を示しています。

using namespace System;
enum class Colors
{
   Red, Green, Blue, Yellow
};

enum class Styles
{
   Plaid = 0,
   Striped = 23,
   Tartan = 65,
   Corduroy = 78
};

int main()
{
   Console::WriteLine(  "The values of the Colors Enum are:" );
   Array^ a = Enum::GetValues( Colors::typeid );
   for ( Int32 i = 0; i < a->Length; i++ )
   {
      Object^ o = a->GetValue( i );
      Console::WriteLine(  "{0}", Enum::Format( Colors::typeid, o,  "D" ) );
   }
   Console::WriteLine();
   Console::WriteLine(  "The values of the Styles Enum are:" );
   Array^ b = Enum::GetValues( Styles::typeid );
   for ( Int32 i = 0; i < b->Length; i++ )
   {
      Object^ o = b->GetValue( i );
      Console::WriteLine(  "{0}", Enum::Format( Styles::typeid, o,  "D" ) );

   }
}
// The example produces the following output:
//       The values of the Colors Enum are:
//       0
//       1
//       2
//       3
//       
//       The values of the Styles Enum are:
//       0
//       23
//       65
//       78

using System;

public class GetValuesTest {
    enum Colors { Red, Green, Blue, Yellow };
    enum Styles { Plaid = 0, Striped = 23, Tartan = 65, Corduroy = 78 };

    public static void Main() {

        Console.WriteLine("The values of the Colors Enum are:");
        foreach(int i in Enum.GetValues(typeof(Colors)))
            Console.WriteLine(i);

        Console.WriteLine();

        Console.WriteLine("The values of the Styles Enum are:");
        foreach(int i in Enum.GetValues(typeof(Styles)))
            Console.WriteLine(i);
    }
}
// The example produces the following output:
//       The values of the Colors Enum are:
//       0
//       1
//       2
//       3
//
//       The values of the Styles Enum are:
//       0
//       23
//       65
//       78

open System

type Colors =
    | Red = 0
    | Green = 1
    | Blue = 2
    | Yellow = 3
    
type Styles =
    | Plaid = 0
    | Striped = 23
    | Tartan = 65
    | Corduroy = 78

printfn $"The values of the Colors Enum are:"
for i in Enum.GetValues typeof<Colors> do
    printfn $"{i}"

printfn "\nThe values of the Styles Enum are:"
for i in Enum.GetValues typeof<Styles> do
    printfn $"{i}"

// The example produces the following output:
//       The values of the Colors Enum are:
//       0
//       1
//       2
//       3
//
//       The values of the Styles Enum are:
//       0
//       23
//       65
//       78

Public Class GetValuesTest
   
    Enum Colors
        Red
        Green
        Blue
        Yellow
    End Enum 'Colors
    
    Enum Styles
        Plaid = 0
        Striped = 23
        Tartan = 65
        Corduroy = 78
    End Enum 'Styles
    
    Public Shared Sub Main()
        
        Console.WriteLine("The values of the Colors Enum are:")
        Dim i As Integer
        For Each i In  [Enum].GetValues(GetType(Colors))
            Console.WriteLine(i)
        Next

        Console.WriteLine()
        
        Console.WriteLine("The values of the Styles Enum are:")
        For Each i In  [Enum].GetValues(GetType(Styles))
            Console.WriteLine(i)
        Next
    End Sub 
End Class 
' The example produces the following output:
'       The values of the Colors Enum are:
'       0
'       1
'       2
'       3
'       
'       The values of the Styles Enum are:
'       0
'       23
'       65
'       78

注釈

配列の要素は、列挙定数のバイナリ値 (つまり、符号なしの大きさ) で並べ替えられます。次の例では、負の値、0、正の値を含む列挙体に対して、GetValuesメソッドによって返される配列に関する情報を表示します。

using System;

enum SignMagnitude { Negative = -1, Zero = 0, Positive = 1 };

public class Example
{
   public static void Main()
   {
      foreach (var value in Enum.GetValues(typeof(SignMagnitude))) {
         Console.WriteLine("{0,3}     0x{0:X8}     {1}",
                           (int) value, ((SignMagnitude) value));
}   }
}
// The example displays the following output:
//         0     0x00000000     Zero
//         1     0x00000001     Positive
//        -1     0xFFFFFFFF     Negative

open System

type SignMagnitude =
    | Negative = -1
    | Zero = 0
    | Positive = 1

for value in Enum.GetValues typeof<SignMagnitude> do
    printfn $"{value :?> int,3}     0x{value :?> int:X8}     {value :?> SignMagnitude}"
// The example displays the following output:
//         0     0x00000000     Zero
//         1     0x00000001     Positive
//        -1     0xFFFFFFFF     Negative

Public Enum SignMagnitude As Integer
   Negative = -1 
   Zero = 0
   Positive = 1
End Enum
   
Module Example
   Public Sub Main()
      Dim values() As Integer = CType([Enum].GetValues(GetType(SignMagnitude)), Integer())
      For Each value In values
         Console.WriteLine("{0,3}     0x{0:X8}     {1}",
                           value, CType(value, SignMagnitude).ToString())
      Next
   End Sub
End Module
' The example displays the following output:
'      0     0x00000000     Zero
'      1     0x00000001     Positive
'     -1     0xFFFFFFFF     Negative

GetValuesメソッドは、 enumType列挙体の各メンバーの値を格納する配列を返します。複数のメンバーが同じ値を持つ場合、返される配列には重複する値が含まれます。この場合、返された配列内の各値を使用してGetNameメソッドを呼び出すと、重複する値を持つメンバーに割り当てられた一意の名前は復元されません。列挙メンバーのすべての名前を正常に取得するには、GetNamesメソッドを呼び出します。

リフレクションのみのコンテキストでは、リフレクションを使用してGetValuesメソッドを呼び出すことはできません。代わりに、Type.GetFieldsメソッドを使用して列挙体のメンバーを表すオブジェクトのFieldInfo配列を取得し、配列の各要素に対してFieldInfo.GetRawConstantValueメソッドを呼び出すことで、すべての列挙体メンバーの値を取得できます。次の例は、この手法を示しています。このためには、Enumerations.dll という名前のアセンブリに次の列挙型を定義する必要があります。

[Flags] enum Pets { None=0, Dog=1, Cat=2, Rodent=4, Bird=8,
                    Fish=16, Reptile=32, Other=64 };

[<Flags>] 
type Pets =
    | None = 0
    | Dog = 1
    | Cat = 2
    | Rodent = 4
    | Bird = 8
    | Fish = 16
    | Reptile = 32
    | Other = 64

<Flags> Public Enum Pets As Integer
   None = 0
   Dog = 1
   Cat = 2
   Rodent = 4
   Bird = 8
   Fish = 16
   Reptile = 32
   Other = 64
End Enum

アセンブリはリフレクションのみのコンテキストで読み込まれます。Pets列挙体を表すTypeオブジェクトがインスタンス化され、FieldInfoオブジェクトの配列が取得され、フィールド値がコンソールに表示されます。

using System;
using System.Reflection;

public class Example
{
   public static void Main()
   {
      Assembly assem = Assembly.ReflectionOnlyLoadFrom(@".\Enumerations.dll");
      Type typ = assem.GetType("Pets");
      FieldInfo[] fields = typ.GetFields();

      foreach (var field in fields) {
         if (field.Name.Equals("value__")) continue;

         Console.WriteLine("{0,-9} {1}", field.Name + ":",
                                         field.GetRawConstantValue());
      }
   }
}
// The example displays the following output:
//       None:     0
//       Dog:      1
//       Cat:      2
//       Rodent:   4
//       Bird:     8
//       Fish:     16
//       Reptile:  32
//       Other:    64

open System
open System.Reflection

let assem = Assembly.ReflectionOnlyLoadFrom @".\Enumerations.dll"
let typ = assem.GetType "Pets"
let fields = typ.GetFields()

for field in fields do
    if not (field.Name.Equals "value__") then

        printfn $"""{field.Name + ":",-9} {field.GetRawConstantValue()}"""
// The example displays the following output:
//       None:     0
//       Dog:      1
//       Cat:      2
//       Rodent:   4
//       Bird:     8
//       Fish:     16
//       Reptile:  32
//       Other:    64

Imports System.Reflection

Module Example
   Public Sub Main()
      Dim assem As Assembly = Assembly.ReflectionOnlyLoadFrom(".\Enumerations.dll")
      Dim typ As Type = assem.GetType("Pets")
      Dim fields As FieldInfo() = typ.GetFields

      For Each field In fields
         If field.Name.Equals("value__") Then Continue For
          
         Console.WriteLine("{0,-9} {1}", field.Name + ":", 
                                         field.GetRawConstantValue())
      Next
   End Sub
End Module
' The example displays the following output:
'       None:     0
'       Dog:      1
'       Cat:      2
'       Rodent:   4
'       Bird:     8
'       Fish:     16
'       Reptile:  32
'       Other:    64

適用対象

GetValues<TEnum>()

指定した列挙型に含まれている定数の値の配列を取得します。

public:
generic <typename TEnum>
 where TEnum : value class static cli::array <TEnum> ^ GetValues();

public static TEnum[] GetValues<TEnum> () where TEnum : struct;

static member GetValues : unit -> 'Enum[] (requires 'Enum : struct)

Public Shared Function GetValues(Of TEnum As Structure) () As TEnum()

型パラメーター

TEnum

列挙体の型。

戻り値

TEnum[]

TEnum に含まれている定数の値を格納する配列。

例外

InvalidOperationException

.NET 8 以降のバージョン: TEnum は、ブール型に基づく列挙型です。

適用対象

Enum.GetValues メソッド

定義

オーバーロード

GetValues(Type)

パラメーター

戻り値

例外

例

注釈

適用対象

GetValues<TEnum>()

型パラメーター

戻り値

例外

適用対象

フィードバック

その他のリソース