Guid.IFormattable.ToString(String, IFormatProvider) Method

Definition

Returns a string representation of the value of this instance, according to the provided format specifier and culture-specific format information.

 virtual System::String ^ System.IFormattable.ToString(System::String ^ format, IFormatProvider ^ provider) = IFormattable::ToString;
string IFormattable.ToString (string format, IFormatProvider provider);
Function ToString (format As String, provider As IFormatProvider) As String Implements IFormattable.ToString

Parameters

format
String

A single format specifier that indicates how to format the value of the Guid. The format parameter can be "N", "D", "B", "P", or "X". If format is null or an empty string (""), "D" is used.

provider
IFormatProvider

(Reserved) An object that supplies culture-specific formatting information.

Returns

The value of this Guid represented as a series of lowercase hexadecimal digits in the specified format.

Implements

Exceptions

The value of format is not null, an empty string (""), or one of the following single format specifiers:"N", "D", "B", "P", or "X".

Remarks

The provider parameter is reserved for future use and does not contribute to the execution of this method. You can pass null in the method call.

The following table shows the accepted format specifiers for the format parameter. "0" represents a digit; hyphens ("-"), braces ("{", "}"), and parentheses ("(", ")") appear as shown.

Specifier Format of return value
N 32 digits:

00000000000000000000000000000000
D 32 digits separated by hyphens:

00000000-0000-0000-0000-000000000000
B 32 digits separated by hyphens, enclosed in braces:

{00000000-0000-0000-0000-000000000000}
P 32 digits separated by hyphens, enclosed in parentheses:

(00000000-0000-0000-0000-000000000000)
X Four hexadecimal values enclosed in braces, where the fourth value is a subset of eight hexadecimal values that is also enclosed in braces:

{0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}}

The hexadecimal digits a through f are lowercase in the returned string. To convert them to uppercase, call the String.ToUpper method on the returned string.

Because the provider parameter is ignored, you cannot use it to provide a custom formatting solution. To represent a Guid value as a string in a format that isn't supported by the standard GUID format strings, call the String.Format(IFormatProvider, String, Object[]) method with a provider object that implements both the ICustomFormatter and IFormatProvider interfaces. For more information, see the "Custom Formatting with ICustomFormatter" section in the Formatting Types article.

Applies to