Enum.GetValues 方法

參考

定義

命名空間:: System

組件:: System.Runtime.dll

組件:: mscorlib.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

GetValues(Type)	在指定的列舉中擷取常數值的陣列。
GetValues<TEnum>()	在指定的列舉類型中擷取常數值的陣列。

GetValues(Type)

來源:: Enum.cs

來源:: Enum.cs

來源:: Enum.cs

在指定的列舉中擷取常數值的陣列。

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

備註

陣列的元素會依列舉常 (數的二進位值排序，也就是其不帶正負號的大小) 。下列範例會顯示方法針對包含負值、零和正值之列舉傳 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無法在僅限反映的內容中使用反映來叫用方法。相反地，您可以使用方法來取得代表列舉成員的物件陣列 FieldInfo ，然後在陣列的每個元素上呼叫 FieldInfo.GetRawConstantValue 方法，以擷取所有列舉成員 Type.GetFields 的值。下列範例說明這項技術。您必須在名為 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

元件會載入僅限反映的內容、 Type 代表 Pets 列舉的物件已具現化、擷取物件的陣列 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>()

來源:: Enum.cs

來源:: Enum.cs

來源:: Enum.cs

在指定的列舉類型中擷取常數值的陣列。

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>()

類型參數

傳回

例外狀況

適用於

其他資源