This topic has not yet been rated - Rate this topic

Guid Structure

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Represents a globally unique identifier (GUID).

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[ComVisibleAttribute(true)]
public struct Guid : IFormattable, IComparable, 
	IComparable<Guid>, IEquatable<Guid>

The Guid type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library Guid(Byte[]) Initializes a new instance of the Guid structure by using the specified array of bytes.
Public method Supported by the XNA Framework Supported by Portable Class Library Guid(String) Initializes a new instance of the Guid structure by using the value represented by the specified string.
Public method Supported by the XNA Framework Guid(Int32, Int16, Int16, Byte[]) Initializes a new instance of the Guid structure by using the specified integers and byte array.
Public method Supported by the XNA Framework Supported by Portable Class Library Guid(Int32, Int16, Int16, Byte, Byte, Byte, Byte, Byte, Byte, Byte, Byte) Initializes a new instance of the Guid structure by using the specified integers and bytes.
Public method Guid(UInt32, UInt16, UInt16, Byte, Byte, Byte, Byte, Byte, Byte, Byte, Byte) Initializes a new instance of the Guid structure by using the specified unsigned integers and bytes.
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library CompareTo(Guid) Compares this instance to a specified Guid object and returns an indication of their relative values.
Public method Supported by the XNA Framework CompareTo(Object) Compares this instance to a specified object and returns an indication of their relative values.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Guid) Returns a value indicating whether this instance and a specified Guid object represent the same value.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Returns a value that indicates whether this instance is equal to a specified object. (Overrides ValueType.Equals(Object).)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Overrides ValueType.GetHashCode().)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Static member Supported by the XNA Framework Supported by Portable Class Library NewGuid Initializes a new instance of the Guid structure.
Public method Static member Parse Converts the string representation of a GUID to the equivalent Guid structure.
Public method Static member ParseExact Converts the string representation of a GUID to the equivalent Guid structure, provided that the string is in the specified format.
Public method Supported by the XNA Framework Supported by Portable Class Library ToByteArray Returns a 16-element byte array that contains the value of this instance.
Public method Supported by the XNA Framework Supported by Portable Class Library ToString() Returns a string representation of the value of this instance in registry format. (Overrides ValueType.ToString().)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString(String) Returns a string representation of the value of this Guid instance, according to the provided format specifier.
Public method Supported by the XNA Framework ToString(String, IFormatProvider) Returns a string representation of the value of this instance of the Guid class, according to the provided format specifier and culture-specific format information.
Public method Static member TryParse Converts the string representation of a GUID to the equivalent Guid structure.
Public method Static member TryParseExact Converts the string representation of a GUID to the equivalent Guid structure, provided that the string is in the specified format.
Top
  Name Description
Public operator Static member Supported by the XNA Framework Supported by Portable Class Library Equality Indicates whether the values of two specified Guid objects are equal.
Public operator Static member Supported by the XNA Framework Supported by Portable Class Library Inequality Indicates whether the values of two specified Guid objects are not equal.
Top
  Name Description
Public field Static member Supported by the XNA Framework Supported by Portable Class Library Empty A read-only instance of the Guid structure whose value is all zeros.
Top
  Name Description
Explicit interface implemetation Private method Supported by Portable Class Library IFormattable.ToString Returns a string representation of the value of this instance, according to the provided format specifier.
Top

A GUID is a 128-bit integer (16 bytes) that can be used across all computers and networks wherever a unique identifier is required. Such an identifier has a very low probability of being duplicated.

The following example uses the System.Runtime.InteropServices.GuidAttribute class to assign a GUID to an interface and to a user-defined class. It retrieves the value of the GUID by calling the GetCustomAttribute method, and compares it with two other GUIDs to determine whether they are equal.


using System;
using System.Runtime.InteropServices;

// Guid for the interface IMyInterface.
[Guid("F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4")]
interface IMyInterface
{
    void MyMethod();
}

// Guid for the coclass MyTestClass.
[Guid("936DA01F-9ABD-4d9d-80C7-02AF85C822A8")]
public class MyTestClass : IMyInterface
{
    public void MyMethod() {}

    public static void Main( string []args )
    {
        GuidAttribute IMyInterfaceAttribute = (GuidAttribute) Attribute.GetCustomAttribute(typeof(IMyInterface), typeof(GuidAttribute));

        System.Console.WriteLine("IMyInterface Attribute: " + IMyInterfaceAttribute.Value );    

        // Use the string to create a guid.
        Guid myGuid1 = new Guid(IMyInterfaceAttribute.Value );
        // Use a byte array to create a guid.
        Guid myGuid2 = new Guid(myGuid1.ToByteArray());

        if (myGuid1.Equals(myGuid2))
            System.Console.WriteLine("myGuid1 equals myGuid2");
        else
            System.Console.WriteLine("myGuid1 does not equal myGuid2" );

        // Equality operator can also be used to determine if two guids have same value.
        if ( myGuid1 == myGuid2 )
            System.Console.WriteLine( "myGuid1 == myGuid2" );
        else
            System.Console.WriteLine( "myGuid1 != myGuid2" );
    }
}
// The example displays the following output:
//       IMyInterface Attribute: F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4
//       myGuid1 equals myGuid2
//       myGuid1 == myGuid2


Note that the GuidAttribute attribute is typically used in an application to expose a type to COM. If you compile this example, you can run the Assembly Registration tool (Regasm.exe) on the generated assembly to create registry (.reg) and type library (.tlb) files. The .reg file can be used to register the coclass in the registry, and the .tlb file can provide metadata for COM interop.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)