Guid.TryParse Method (System)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

Guid.TryParse Method

Updated: August 2011

Converts the string representation of a GUID to the equivalent Guid structure.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic

Public Shared Function TryParse ( _
	input As String, _
	<OutAttribute> ByRef result As Guid _
) As Boolean

public static bool TryParse(
	string input,
	out Guid result
)

Visual C++

public:
static bool TryParse(
	String^ input, 
	[OutAttribute] Guid% result
)

static member TryParse : 
        input:string * 
        result:Guid byref -> bool

Parameters

input: Type: System.String
The GUID to convert.

result: Type: System.Guid%
The structure that will contain the parsed value.

Return Value

Type: System.Boolean
true if the parse operation was successful; otherwise, false.

Remarks

This method returns false if input is null or not in a recognized format, and does not throw an exception.

Examples

The following example creates a new GUID, converts it to three separate string representations by calling the ToString method with the "B", "D", and "X" format specifiers, and then calls the TryParse method to convert the strings back to Guid values.

Visual Basic


Module Example
   Public Sub Main()
      Dim originalGuid As Guid = Guid.NewGuid()
      ' Create an array of string representations of the GUID.
      Dim stringGuids() As String = { originalGuid.ToString("B"),
                                      originalGuid.ToString("D"),
                                      originalGuid.ToString("X") }

      ' Parse each string representation.
      Dim newGuid As Guid
      For Each stringGuid In stringGuids
         If Guid.TryParse(stringGuid, newGuid) Then
            Console.WriteLine("Converted {0} to a Guid", stringGuid)
         Else
            Console.WriteLine("Unable to convert {0} to a Guid", 
                              stringGuid)
         End If     
      Next                                      
   End Sub
End Module
' The example displays the following output:
'    Converted {81a130d2-502f-4cf1-a376-63edeb000e9f} to a Guid
'    Converted 81a130d2-502f-4cf1-a376-63edeb000e9f to a Guid
'    Converted {0x81a130d2,0x502f,0x4cf1,{0xa3,0x76,0x63,0xed,0xeb,0x00,0x0e,0x9f}} to a Guid


using System;

public class Example
{
   public static void Main()
   {
      Guid originalGuid = Guid.NewGuid();
      // Create an array of string representations of the GUID.
      string[] stringGuids = { originalGuid.ToString("B"),
                               originalGuid.ToString("D"),
                               originalGuid.ToString("X") };

      // Parse each string representation.
      Guid newGuid;
      foreach (var stringGuid in stringGuids) {
         if (Guid.TryParse(stringGuid, out newGuid))
            Console.WriteLine("Converted {0} to a Guid", stringGuid);
         else
            Console.WriteLine("Unable to convert {0} to a Guid", 
                              stringGuid);
      }                                      
   }
}
// The example displays the following output:
//    Converted {81a130d2-502f-4cf1-a376-63edeb000e9f} to a Guid
//    Converted 81a130d2-502f-4cf1-a376-63edeb000e9f to a Guid
//    Converted {0x81a130d2,0x502f,0x4cf1,{0xa3,0x76,0x63,0xed,0xeb,0x00,0x0e,0x9f}} to a Guid

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Guid Structure

System Namespace

Parse

Change History

Date	History	Reason
August 2011	Replaced the example.	Information enhancement.

Date

History

Reason

August 2011

Replaced the example.

Information enhancement.