M_CodeJam_Strings_StringExtensions_ToUInt16

StringExtensions.ToUInt16 Method

Converts the string representation of a number in a specified style and culture-specific format to its UInt16 equivalent. A return value indicates whether the conversion succeeded.

Namespace: CodeJam.Strings
Assembly: CodeJam (in CodeJam.dll) Version: 2.1.0.0

Syntax

C#

public static Nullable<ushort> ToUInt16(
	this string str,
	NumberStyles numberStyle = NumberStyles.Integer,
	IFormatProvider provider = null
)

VB

<ExtensionAttribute>
Public Shared Function ToUInt16 ( 
	str As String,
	Optional numberStyle As NumberStyles = NumberStyles.Integer,
	Optional provider As IFormatProvider = Nothing
) As Nullable(Of UShort)

F#

[<ExtensionAttribute>]
static member ToUInt16 : 
        str : string * 
        ?numberStyle : NumberStyles * 
        ?provider : IFormatProvider 
(* Defaults:
        let _numberStyle = defaultArg numberStyle NumberStyles.Integer
        let _provider = defaultArg provider null
*)
-> Nullable<uint16> 

Parameters

 

str

Type: System.String
A string containing a number to convert. The string is interpreted using the style specified by numberStyle.

numberStyle (Optional)

Type: System.Globalization.NumberStyles
A bitwise combination of enumeration values that indicates the style elements that can be present in str. Default value is Integer.

provider (Optional)

Type: System.IFormatProvider
An object that supplies culture-specific formatting information about str.

Return Value

Type: Nullable(UInt16)
When this method returns, contains the UInt16 value equivalent of the number contained in str, if the conversion succeeded, or null if the conversion failed. The conversion fails if the str parameter is null or String.Empty, is not in a format compliant withstyle, or represents a number less than MinValue or greater than MaxValue.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also

Reference

StringExtensions Class
CodeJam.Strings Namespace