mscorlib(4.0.0.0) API with additions
System.Int16 Struct Reference

Represents a 16-bit signed integer. More...

Inheritance diagram for System.Int16:
[legend]
Collaboration diagram for System.Int16:
[legend]

Public Member Functions

int CompareTo (object value)
 Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the object. More...
 
int CompareTo (short value)
 Compares this instance to a specified 16-bit signed integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified 16-bit signed integer. More...
 
override bool Equals (object obj)
 Returns a value indicating whether this instance is equal to a specified object. More...
 
bool Equals (short obj)
 Returns a value indicating whether this instance is equal to a specified T:System.Int16 value. More...
 
override int GetHashCode ()
 Returns the hash code for this instance. More...
 
override string ToString ()
 Converts the numeric value of this instance to its equivalent string representation. More...
 
string ToString (IFormatProvider provider)
 Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. More...
 
string ToString (string format)
 Converts the numeric value of this instance to its equivalent string representation, using the specified format. More...
 
string ToString (string format, IFormatProvider provider)
 Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific formatting information. More...
 
TypeCode GetTypeCode ()
 Returns the T:System.TypeCode for value type T:System.Int16. More...
 
bool IConvertible. ToBoolean (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToBoolean(System.IFormatProvider). More...
 
char IConvertible. ToChar (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToChar(System.IFormatProvider). More...
 
sbyte IConvertible. ToSByte (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToSByte(System.IFormatProvider). More...
 
byte IConvertible. ToByte (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToByte(System.IFormatProvider). More...
 
short IConvertible. ToInt16 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToInt16(System.IFormatProvider). More...
 
ushort IConvertible. ToUInt16 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToUInt16(System.IFormatProvider). More...
 
int IConvertible. ToInt32 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToInt32(System.IFormatProvider). More...
 
uint IConvertible. ToUInt32 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToUInt32(System.IFormatProvider). More...
 
long IConvertible. ToInt64 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToInt64(System.IFormatProvider). More...
 
ulong IConvertible. ToUInt64 (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToUInt64(System.IFormatProvider). More...
 
float IConvertible. ToSingle (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToSingle(System.IFormatProvider). More...
 
double IConvertible. ToDouble (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToDouble(System.IFormatProvider). More...
 
decimal IConvertible. ToDecimal (IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToDecimal(System.IFormatProvider). More...
 
DateTime IConvertible. ToDateTime (IFormatProvider provider)
 This conversion is not supported. Attempting to use this method throws an T:System.InvalidCastException. More...
 
object IConvertible. ToType (Type type, IFormatProvider provider)
 For a description of this member, see M:System.IConvertible.ToType(System.Type,System.IFormatProvider). More...
 
- Public Member Functions inherited from System.IEquatable< short >
bool Equals (T other)
 Indicates whether the current object is equal to another object of the same type. More...
 

Static Public Member Functions

static short Parse (string s)
 Converts the string representation of a number to its 16-bit signed integer equivalent. More...
 
static short Parse (string s, NumberStyles style)
 Converts the string representation of a number in a specified style to its 16-bit signed integer equivalent. More...
 
static short Parse (string s, IFormatProvider provider)
 Converts the string representation of a number in a specified culture-specific format to its 16-bit signed integer equivalent. More...
 
static short Parse (string s, NumberStyles style, IFormatProvider provider)
 Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. More...
 
static bool TryParse (string s, out short result)
 Converts the string representation of a number to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed. More...
 
static bool TryParse (string s, NumberStyles style, IFormatProvider provider, out short result)
 Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed. More...
 

Public Attributes

internal short m_value
 
const short MaxValue = 32767
 Represents the largest possible value of an T:System.Int16. This field is constant. More...
 
const short MinValue = -32768
 Represents the smallest possible value of T:System.Int16. This field is constant. More...
 

Detailed Description

Represents a 16-bit signed integer.

Definition at line 12 of file Int16.cs.

Member Function Documentation

◆ CompareTo() [1/2]

int System.Int16.CompareTo ( object  value)

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the object.

Parameters
valueAn object to compare, or null.
Returns
A signed number indicating the relative values of this instance and value .Return Value Description Less than zero This instance is less than value . Zero This instance is equal to value . Greater than zero This instance is greater than value .-or- value is null.
Exceptions
T:System.ArgumentExceptionvalue is not an T:System.Int16.

Definition at line 30 of file Int16.cs.

◆ CompareTo() [2/2]

int System.Int16.CompareTo ( short  value)

Compares this instance to a specified 16-bit signed integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified 16-bit signed integer.

Parameters
valueAn integer to compare.
Returns
A signed number indicating the relative values of this instance and value .Return Value Description Less than zero This instance is less than value . Zero This instance is equal to value . Greater than zero This instance is greater than value .

Definition at line 47 of file Int16.cs.

◆ Equals() [1/2]

override bool System.Int16.Equals ( object  obj)

Returns a value indicating whether this instance is equal to a specified object.

Parameters
objAn object to compare to this instance.
Returns
true if obj is an instance of T:System.Int16 and equals the value of this instance; otherwise, false.

Definition at line 57 of file Int16.cs.

◆ Equals() [2/2]

bool System.Int16.Equals ( short  obj)

Returns a value indicating whether this instance is equal to a specified T:System.Int16 value.

Parameters
objAn T:System.Int16 value to compare to this instance.
Returns
true if obj has the same value as this instance; otherwise, false.

Definition at line 72 of file Int16.cs.

◆ GetHashCode()

override int System.Int16.GetHashCode ( )

Returns the hash code for this instance.

Returns
A 32-bit signed integer hash code.

Definition at line 80 of file Int16.cs.

◆ GetTypeCode()

TypeCode System.Int16.GetTypeCode ( )

Returns the T:System.TypeCode for value type T:System.Int16.

Returns
The enumerated constant, F:System.TypeCode.Int16.

Implements System.IConvertible.

Definition at line 288 of file Int16.cs.

◆ Parse() [1/4]

static short System.Int16.Parse ( string  s)
static

Converts the string representation of a number to its 16-bit signed integer equivalent.

Parameters
sA string containing a number to convert.
Returns
A 16-bit signed integer equivalent to the number contained in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.FormatExceptions is not in the correct format.
T:System.OverflowExceptions represents a number less than F:System.Int16.MinValue or greater than F:System.Int16.MaxValue.

Definition at line 144 of file Int16.cs.

◆ Parse() [2/4]

static short System.Int16.Parse ( string  s,
NumberStyles  style 
)
static

Converts the string representation of a number in a specified style to its 16-bit signed integer equivalent.

Parameters
sA string containing a number to convert.
styleA bitwise combination of the enumeration values that indicates the style elements that can be present in s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
Returns
A 16-bit signed integer equivalent to the number specified in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.ArgumentExceptionstyle is not a T:System.Globalization.NumberStyles value. -or- style is not a combination of F:System.Globalization.NumberStyles.AllowHexSpecifier and F:System.Globalization.NumberStyles.HexNumber values.
T:System.FormatExceptions is not in a format compliant with style .
T:System.OverflowExceptions represents a number less than F:System.Int16.MinValue or greater than F:System.Int16.MaxValue. -or- s includes non-zero fractional digits.

Definition at line 164 of file Int16.cs.

◆ Parse() [3/4]

static short System.Int16.Parse ( string  s,
IFormatProvider  provider 
)
static

Converts the string representation of a number in a specified culture-specific format to its 16-bit signed integer equivalent.

Parameters
sA string containing a number to convert.
providerAn T:System.IFormatProvider that supplies culture-specific formatting information about s .
Returns
A 16-bit signed integer equivalent to the number specified in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.FormatExceptions is not in the correct format.
T:System.OverflowExceptions represents a number less than F:System.Int16.MinValue or greater than F:System.Int16.MaxValue.

Definition at line 181 of file Int16.cs.

◆ Parse() [4/4]

static short System.Int16.Parse ( string  s,
NumberStyles  style,
IFormatProvider  provider 
)
static

Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.

Parameters
sA string containing a number to convert.
styleA bitwise combination of enumeration values that indicates the style elements that can be present in s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
providerAn T:System.IFormatProvider that supplies culture-specific formatting information about s .
Returns
A 16-bit signed integer equivalent to the number specified in s .
Exceptions
T:System.ArgumentNullExceptions is null.
T:System.ArgumentExceptionstyle is not a T:System.Globalization.NumberStyles value. -or- style is not a combination of F:System.Globalization.NumberStyles.AllowHexSpecifier and F:System.Globalization.NumberStyles.HexNumber values.
T:System.FormatExceptions is not in a format compliant with style .
T:System.OverflowExceptions represents a number less than F:System.Int16.MinValue or greater than F:System.Int16.MaxValue. -or- s includes non-zero fractional digits.

Definition at line 202 of file Int16.cs.

◆ ToBoolean()

bool IConvertible. System.Int16.ToBoolean ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToBoolean(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
true if the value of the current instance is not zero; otherwise, false.

Implements System.IConvertible.

Definition at line 298 of file Int16.cs.

◆ ToByte()

byte IConvertible. System.Int16.ToByte ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToByte(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Byte.

Implements System.IConvertible.

Definition at line 325 of file Int16.cs.

◆ ToChar()

char IConvertible. System.Int16.ToChar ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToChar(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Char.

Implements System.IConvertible.

Definition at line 307 of file Int16.cs.

◆ ToDateTime()

DateTime IConvertible. System.Int16.ToDateTime ( IFormatProvider  provider)

This conversion is not supported. Attempting to use this method throws an T:System.InvalidCastException.

Parameters
providerThis parameter is ignored.
Returns
This conversion is not supported. No value is returned.
Exceptions
T:System.InvalidCastExceptionIn all cases.

Implements System.IConvertible.

Definition at line 416 of file Int16.cs.

◆ ToDecimal()

decimal IConvertible. System.Int16.ToDecimal ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToDecimal(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Decimal.

Implements System.IConvertible.

Definition at line 406 of file Int16.cs.

◆ ToDouble()

double IConvertible. System.Int16.ToDouble ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToDouble(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Double.

Implements System.IConvertible.

Definition at line 397 of file Int16.cs.

◆ ToInt16()

short IConvertible. System.Int16.ToInt16 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToInt16(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, unchanged.

Implements System.IConvertible.

Definition at line 334 of file Int16.cs.

◆ ToInt32()

int IConvertible. System.Int16.ToInt32 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToInt32(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.Int32.

Implements System.IConvertible.

Definition at line 352 of file Int16.cs.

◆ ToInt64()

long IConvertible. System.Int16.ToInt64 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToInt64(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.Int64.

Implements System.IConvertible.

Definition at line 370 of file Int16.cs.

◆ ToSByte()

sbyte IConvertible. System.Int16.ToSByte ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToSByte(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to an T:System.SByte.

Implements System.IConvertible.

Definition at line 316 of file Int16.cs.

◆ ToSingle()

float IConvertible. System.Int16.ToSingle ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToSingle(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.Single.

Implements System.IConvertible.

Definition at line 388 of file Int16.cs.

◆ ToString() [1/4]

override string System.Int16.ToString ( )

Converts the numeric value of this instance to its equivalent string representation.

Returns
The string representation of the value of this instance, consisting of a minus sign if the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeroes.

Definition at line 89 of file Int16.cs.

◆ ToString() [2/4]

string System.Int16.ToString ( IFormatProvider  provider)

Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.

Parameters
providerAn T:System.IFormatProvider that supplies culture-specific formatting information.
Returns
The string representation of the value of this instance as specified by provider .

Implements System.IConvertible.

Definition at line 99 of file Int16.cs.

◆ ToString() [3/4]

string System.Int16.ToString ( string  format)

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

Parameters
formatA numeric format string.
Returns
The string representation of the value of this instance as specified by format .

Definition at line 108 of file Int16.cs.

◆ ToString() [4/4]

string System.Int16.ToString ( string  format,
IFormatProvider  provider 
)

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific formatting information.

Parameters
formatA numeric format string.
providerAn object that supplies culture-specific formatting information.
Returns
The string representation of the value of this instance as specified by format and provider .

Implements System.IFormattable.

Definition at line 118 of file Int16.cs.

◆ ToType()

object IConvertible. System.Int16.ToType ( Type  type,
IFormatProvider  provider 
)

For a description of this member, see M:System.IConvertible.ToType(System.Type,System.IFormatProvider).

Parameters
typeThe type to which to convert this T:System.Int16 value.
providerAn T:System.IFormatProvider implementation that supplies information about the format of the returned value.
Returns
The value of the current instance, converted to type .

Implements System.IConvertible.

Definition at line 426 of file Int16.cs.

◆ ToUInt16()

ushort IConvertible. System.Int16.ToUInt16 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToUInt16(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, unchanged.

Implements System.IConvertible.

Definition at line 343 of file Int16.cs.

◆ ToUInt32()

uint IConvertible. System.Int16.ToUInt32 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToUInt32(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.UInt32.

Implements System.IConvertible.

Definition at line 361 of file Int16.cs.

◆ ToUInt64()

ulong IConvertible. System.Int16.ToUInt64 ( IFormatProvider  provider)

For a description of this member, see M:System.IConvertible.ToUInt64(System.IFormatProvider).

Parameters
providerThis parameter is ignored.
Returns
The value of the current instance, converted to a T:System.UInt64.

Implements System.IConvertible.

Definition at line 379 of file Int16.cs.

◆ TryParse() [1/2]

static bool System.Int16.TryParse ( string  s,
out short  result 
)
static

Converts the string representation of a number to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters
sA string containing a number to convert.
resultWhen this method returns, contains the 16-bit signed integer value equivalent to the number contained in s , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or F:System.String.Empty, is not of the correct format, or represents a number less than F:System.Int16.MinValue or greater than F:System.Int16.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.
Returns
true if s was converted successfully; otherwise, false.

Definition at line 240 of file Int16.cs.

◆ TryParse() [2/2]

static bool System.Int16.TryParse ( string  s,
NumberStyles  style,
IFormatProvider  provider,
out short  result 
)
static

Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed.

Parameters
sA string containing a number to convert. The string is interpreted using the style specified by style .
styleA bitwise combination of enumeration values that indicates the style elements that can be present in s . A typical value to specify is F:System.Globalization.NumberStyles.Integer.
providerAn object that supplies culture-specific formatting information about s .
resultWhen this method returns, contains the 16-bit signed integer value equivalent to the number contained in s , if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is null or F:System.String.Empty, is not in a format compliant with style , or represents a number less than F:System.Int16.MinValue or greater than F:System.Int16.MaxValue. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.
Returns
true if s was converted successfully; otherwise, false.
Exceptions
T:System.ArgumentExceptionstyle is not a T:System.Globalization.NumberStyles value. -or- style is not a combination of F:System.Globalization.NumberStyles.AllowHexSpecifier and F:System.Globalization.NumberStyles.HexNumber values.

Definition at line 256 of file Int16.cs.

Member Data Documentation

◆ MaxValue

const short System.Int16.MaxValue = 32767

Represents the largest possible value of an T:System.Int16. This field is constant.

Definition at line 18 of file Int16.cs.

◆ MinValue

const short System.Int16.MinValue = -32768

Represents the smallest possible value of T:System.Int16. This field is constant.

Definition at line 22 of file Int16.cs.


The documentation for this struct was generated from the following file: