This documentation is archived and is not being maintained.

Convert::ToUInt64 Method (String, IFormatProvider)

Converts the specified string representation of a number to an equivalent 64-bit unsigned integer, using the specified culture-specific formatting information.

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
public:
static unsigned long long ToUInt64(
	String^ value, 
	IFormatProvider^ provider
)

Parameters

value
Type: System::String
A string that contains the number to convert.
provider
Type: System::IFormatProvider
An object that supplies culture-specific formatting information.

Return Value

Type: System::UInt64
A 64-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is nullptr.

ExceptionCondition
FormatException

value does not consist of an optional sign followed by a sequence of digits (0 through 9).

OverflowException

value represents a number that is less than UInt64::MinValue or greater than UInt64::MaxValue.

The return value is the result of invoking UInt64::Parse on value.

provider is an IFormatProvider implementation that obtains a NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is nullptr, the NumberFormatInfo object for the current culture is used.

If you prefer not to handle an exception if the conversion fails, you can call the UInt64::TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

The following example defines a custom NumberFormatInfo object that recognizes the string "pos" as the positive sign and the string "neg" as the negative sign. It then attempts to convert each element of a numeric string array to an unsigned long integer. The conversion uses both the custom provider and the NumberFormatInfo provider for the invariant culture.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 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 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.
Show: