Enum.TryParse Método

public:
 static bool TryParse(Type ^ enumType, System::String ^ value, bool ignoreCase, [Runtime::InteropServices::Out] System::Object ^ % result);

public static bool TryParse(Type enumType, string value, bool ignoreCase, out object result);

static member TryParse : Type * string * bool * obj -> bool

Public Shared Function TryParse (enumType As Type, value As String, ignoreCase As Boolean, ByRef result As Object) As Boolean

Parámetros

Devoluciones

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

public:
 static bool TryParse(Type ^ enumType, System::String ^ value, [Runtime::InteropServices::Out] System::Object ^ % result);

public static bool TryParse(Type enumType, string value, out object result);

static member TryParse : Type * string * obj -> bool

Public Shared Function TryParse (enumType As Type, value As String, ByRef result As Object) As Boolean

Parámetros

Devoluciones

true si la conversión se realizó correctamente; false de lo contrario.

Excepciones

public:
generic <typename TEnum>
 where TEnum : value class static bool TryParse(System::String ^ value, bool ignoreCase, [Runtime::InteropServices::Out] TEnum % result);

public static bool TryParse<TEnum>(string value, bool ignoreCase, out TEnum result) where TEnum : struct;

static member TryParse : string * bool * 'Enum -> bool (requires 'Enum : struct)

Public Shared Function TryParse(Of TEnum As Structure) (value As String, ignoreCase As Boolean, ByRef result As TEnum) As Boolean

Parámetros de tipo

Parámetros

Devoluciones

true es si el value parámetro se ha convertido correctamente; de lo contrario, falsees .

Excepciones

Ejemplos

En el ejemplo siguiente se define una Colors enumeración, se llama al TryParse<TEnum>(String, Boolean, TEnum) método para convertir cadenas en sus valores de enumeración correspondientes y se llama al IsDefined método para asegurarse de que los valores enteros concretos son valores subyacentes en la Colors enumeración. El TryParse<TEnum>(String, Boolean, TEnum) método usa una comparación que no distingue mayúsculas de minúsculas al intentar convertir las representaciones de cadena de constantes con nombre en sus valores de enumeración equivalentes.

using System;

[Flags] enum Colors { None=0, Red = 1, Green = 2, Blue = 4 };

public class Example
{
   public static void Main()
   {
      string[] colorStrings = { "0", "2", "8", "blue", "Blue", "Yellow", "Red, Green" };
      foreach (string colorString in colorStrings)
      {
         Colors colorValue;
         if (Enum.TryParse(colorString, true, out colorValue))
            if (Enum.IsDefined(typeof(Colors), colorValue) | colorValue.ToString().Contains(","))
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString());
            else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString);
         else
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString);
      }
   }
}
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       Converted 'blue' to Blue.
//       Converted 'Blue' to Blue.
//       Yellow is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

open System

[<Flags>]
type Colors =
    | None = 0
    | Red = 1
    | Green = 2
    | Blue = 4

let colorStrings = 
    [ "0"; "2"; "8"; "blue"; "Blue"; "Yellow"; "Red, Green" ]
for colorString in colorStrings do
    match Enum.TryParse(colorString, true) with
    | true, colorValue ->
        if Enum.IsDefined(typeof<Colors>, colorValue) || (string colorValue).Contains "," then
            printfn $"Converted '{colorString}' to {colorValue}."
        else
            printfn $"{colorString} is not an underlying value of the Colors enumeration."
    | _ ->
        printfn $"{colorString} is not a member of the Colors enumeration."
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       Converted 'blue' to Blue.
//       Converted 'Blue' to Blue.
//       Yellow is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

<Flags> Enum Colors As Integer
   None = 0
   Red = 1
   Green = 2
   Blue = 4
End Enum

Module Example
   Public Sub Main()
      Dim colorStrings() As String = {"0", "2", "8", "blue", "Blue", "Yellow", "Red, Green"}
      For Each colorString As String In colorStrings
         Dim colorValue As Colors
         If [Enum].TryParse(colorString, True, colorValue) Then        
            If [Enum].IsDefined(GetType(Colors), colorValue) Or colorValue.ToString().Contains(",") Then 
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString())
            Else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString)            
            End If                    
         Else
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString)
         End If
      Next
   End Sub
End Module
' The example displays the following output:
'       Converted '0' to None.
'       Converted '2' to Green.
'       8 is not an underlying value of the Colors enumeration.
'       Converted 'blue' to Blue.
'       Converted 'Blue' to Blue.
'       Yellow is not a member of the Colors enumeration.
'       Converted 'Red, Green' to Red, Green.

Comentarios

TryParse<TEnum>(String, Boolean, TEnum) es idéntico al Parse(Type, String, Boolean) método , excepto que en lugar de producir una excepción, devuelve si se produce false un error en la conversión. Elimina la necesidad de controlar excepciones al analizar la representación de cadena de un valor de enumeración.

El value parámetro contiene la representación de cadena del valor subyacente o constante con nombre de un miembro de enumeración, o una lista de constantes con nombre o valores subyacentes delimitados por comas (,). Si value incluye varias constantes o valores con nombre, uno o varios espacios en blanco pueden preceder o seguir cada valor, nombre o coma en value. Si value es una lista, result refleja el valor de los nombres especificados o los valores subyacentes combinados con una operación bit a bit OR . Si value es la representación de cadena del nombre de un valor de enumeración, la comparación de con nombres de value enumeración depende del ignoreCase parámetro . Si truees , la comparación no distingue mayúsculas de minúsculas; si falsees , distingue mayúsculas de minúsculas.

Si value es un nombre que no corresponde a una constante con nombre de TEnum, el método devuelve false. Si value es la representación de cadena de un entero que no representa un valor subyacente de la TEnum enumeración, el método devuelve un miembro de enumeración cuyo valor subyacente se value convierte en un tipo entero. Si este comportamiento no es deseable, llame al IsDefined método para asegurarse de que una representación de cadena determinada de un entero es realmente miembro de TEnum.

Si se produce un error en la operación de análisis, el result parámetro contiene el valor predeterminado de 0, que puede no ser miembro de la enumeración subyacente TEnum . Si no se asigna ningún valor a las constantes con nombre en TEnum, el valor predeterminado es igual al primer miembro de TEnum. De lo contrario, el valor predeterminado es igual al miembro de la enumeración con un valor asignado de 0.

Consulte también

• Parse(Type, String, Boolean)

public:
generic <typename TEnum>
 where TEnum : value class static bool TryParse(System::String ^ value, [Runtime::InteropServices::Out] TEnum % result);

public static bool TryParse<TEnum>(string value, out TEnum result) where TEnum : struct;

static member TryParse : string * 'Enum -> bool (requires 'Enum : struct)

Public Shared Function TryParse(Of TEnum As Structure) (value As String, ByRef result As TEnum) As Boolean

Parámetros de tipo

Parámetros

Devoluciones

true es si el value parámetro se ha convertido correctamente; de lo contrario, falsees .

Excepciones

Ejemplos

En el ejemplo siguiente se define una Colors enumeración, se llama al TryParse<TEnum>(String, TEnum) método para convertir cadenas en sus valores de enumeración correspondientes y se llama al IsDefined método para asegurarse de que los valores enteros concretos son valores subyacentes en la Colors enumeración.

using System;

[Flags] enum Colors { None=0, Red = 1, Green = 2, Blue = 4 };

public class Example
{
   public static void Main()
   {
      string[] colorStrings = { "0", "2", "8", "blue", "Blue", "Yellow", "Red, Green" };
      foreach (string colorString in colorStrings)
      {
         Colors colorValue;
         if (Enum.TryParse(colorString, out colorValue))
            if (Enum.IsDefined(typeof(Colors), colorValue) | colorValue.ToString().Contains(","))
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString());
            else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString);
         else
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString);
      }
   }
}
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       blue is not a member of the Colors enumeration.
//       Converted 'Blue' to Blue.
//       Yellow is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

open System

[<Flags>]
type Colors =
    | None = 0
    | Red = 1
    | Green = 2
    | Blue = 4

let colorStrings = 
    [ "0"; "2"; "8"; "blue"; "Blue"; "Yellow"; "Red, Green" ]
for colorString in colorStrings do
    match Enum.TryParse colorString with
    | true, colorValue ->
        if Enum.IsDefined(typeof<Colors>, colorValue) || (string colorValue).Contains "," then
            printfn $"Converted '{colorString}' to {colorValue}."
        else
            printfn $"{colorString} is not an underlying value of the Colors enumeration."
    | _ ->
        printfn $"{colorString} is not a member of the Colors enumeration."
// The example displays the following output:
//       Converted '0' to None.
//       Converted '2' to Green.
//       8 is not an underlying value of the Colors enumeration.
//       blue is not a member of the Colors enumeration.
//       Converted 'Blue' to Blue.
//       Yellow is not a member of the Colors enumeration.
//       Converted 'Red, Green' to Red, Green.

<Flags> Enum Colors As Integer
   None = 0
   Red = 1
   Green = 2
   Blue = 4
End Enum

Module Example
   Public Sub Main()
      Dim colorStrings() As String = {"0", "2", "8", "blue", "Blue", "Yellow", "Red, Green"}
      For Each colorString As String In colorStrings
         Dim colorValue As Colors
         If [Enum].TryParse(colorString, colorValue) Then        
            If [Enum].IsDefined(GetType(Colors), colorValue) Or colorValue.ToString().Contains(",") Then 
               Console.WriteLine("Converted '{0}' to {1}.", colorString, colorValue.ToString())
            Else
               Console.WriteLine("{0} is not an underlying value of the Colors enumeration.", colorString)            
            End If                    
         Else
            Console.WriteLine("{0} is not a member of the Colors enumeration.", colorString)
         End If
      Next
   End Sub
End Module
' The example displays the following output:
'    Converted '0' to None.
'    Converted '2' to Green.
'    8 is not an underlying value of the Colors enumeration.
'    blue is not a member of the Colors enumeration.
'    Converted 'Blue' to Blue.
'    Yellow is not a member of the Colors enumeration.
'    Converted 'Red, Green' to Red, Green.

Comentarios

TryParse<TEnum>(String, TEnum) es idéntico al Parse(Type, String) método , excepto que en lugar de producir una excepción, devuelve si se produce false un error en la conversión. Elimina la necesidad de controlar excepciones al analizar la representación de cadena de un valor de enumeración.

El value parámetro contiene la representación de cadena del valor subyacente o constante con nombre de un miembro de enumeración, o una lista de constantes con nombre o valores subyacentes delimitados por comas (,). Si value incluye varias constantes o valores con nombre, uno o varios espacios en blanco pueden preceder o seguir cada valor, nombre o coma en value. Si value es una lista, result refleja el valor de los nombres especificados o los valores subyacentes combinados con una operación bit a bit OR . Si value es la representación de cadena del nombre de un valor de enumeración, la comparación de con nombres de enumeración distingue mayúsculas de value minúsculas.

Si value es un nombre que no corresponde a una constante con nombre de TEnum, el método devuelve false. Si value es la representación de cadena de un entero que no representa un valor subyacente de la TEnum enumeración, el método devuelve un miembro de enumeración cuyo valor subyacente se value convierte en un tipo entero. Si este comportamiento no es deseable, llame al IsDefined método para asegurarse de que una representación de cadena determinada de un entero es realmente miembro de TEnum.

Si se produce un error en la operación de análisis, el result parámetro contiene el valor predeterminado de 0, que puede no ser miembro de la enumeración subyacente TEnum . Si no se asigna ningún valor a las constantes con nombre en TEnum, el valor predeterminado es igual al primer miembro de TEnum. De lo contrario, el valor predeterminado es igual al miembro de la enumeración con un valor asignado de 0.

Consulte también

• Parse(Type, String)