Guid.ToString Method (String) (System)

.NET Framework Class Library

Guid..::.ToString Method (String)

Returns a String representation of the value of this Guid instance, according to the provided format specifier.

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

Syntax

Visual Basic (Declaration)

Public Function ToString ( _
    format As String _
) As String

Visual Basic (Usage)

Dim instance As Guid
Dim format As String
Dim returnValue As String

returnValue = instance.ToString(format)

public string ToString(
    string format
)

Visual C++

public:
String^ ToString(
    String^ format
)

JScript

public function ToString(
    format : String
) : String

Parameters

format: Type: System..::.String
A single format specifier that indicates how to format the value of this Guid. The format parameter can be "N", "D", "B", or "P". If format is nullNothingnullptra null reference (Nothing in Visual Basic) or the empty string (""), "D" is used.

Return Value

Type: System..::.String
A String representation of the value of this Guid.

Exceptions

Exception	Condition
FormatException	The value of format is not nullNothingnullptra null reference (Nothing in Visual Basic), the empty string (""), "N", "D", "B", or "P".

Remarks

The format parameter can contain the following format specifiers. In the table that follows, all digits in the return value are hexadecimal. Each character 'x' represents a hexadecimal digit; each hyphen ('-'), bracket ('{', '}'), and parenthesis ('(', ')') appears as shown.

Specifier	Format of Return Value
N	32 digits: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
D	32 digits separated by hyphens: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
B	32 digits separated by hyphens, enclosed in brackets: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
P	32 digits separated by hyphens, enclosed in parentheses: (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference