Skip to content

Commit 36cd913

Browse files
Update BitConverter.xml (#9809)
Update remarks table for class-level documentation
1 parent dd20d4c commit 36cd913

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

xml/System/BitConverter.xml

+13-12
Original file line numberDiff line numberDiff line change
@@ -73,18 +73,19 @@
7373
## Remarks
7474
The <xref:System.BitConverter> class helps manipulate value types in their fundamental form, as a series of bytes. A byte is defined as an 8-bit unsigned integer. The <xref:System.BitConverter> class includes static methods to convert each of the primitive types to and from an array of bytes, as the following table illustrates.
7575
76-
|Type|To byte conversion|From byte conversion|
77-
|----------|------------------------|--------------------------|
78-
|<xref:System.Boolean>|<xref:System.BitConverter.GetBytes%28System.Boolean%29>|<xref:System.BitConverter.ToBoolean%2A>|
79-
|<xref:System.Char>|<xref:System.BitConverter.GetBytes%28System.Char%29>|<xref:System.BitConverter.ToChar%2A>|
80-
|<xref:System.Double>|<xref:System.BitConverter.GetBytes%28System.Double%29><br /><br /> -or-<br /><br /> <xref:System.BitConverter.DoubleToInt64Bits%28System.Double%29>|<xref:System.BitConverter.ToDouble%2A><br /><br /> -or-<br /><br /> <xref:System.BitConverter.Int64BitsToDouble%2A>|
81-
|<xref:System.Int16>|<xref:System.BitConverter.GetBytes%28System.Int16%29>|<xref:System.BitConverter.ToInt16%2A>|
82-
|<xref:System.Int32>|<xref:System.BitConverter.GetBytes%28System.Int32%29>|<xref:System.BitConverter.ToInt32%2A>|
83-
|<xref:System.Int64>|<xref:System.BitConverter.GetBytes%28System.Int64%29>|<xref:System.BitConverter.ToInt64%2A>|
84-
|<xref:System.Single>|<xref:System.BitConverter.GetBytes%28System.Single%29>|<xref:System.BitConverter.ToSingle%2A>|
85-
|<xref:System.UInt16>|<xref:System.BitConverter.GetBytes%28System.UInt16%29>|<xref:System.BitConverter.ToUInt16%2A>|
86-
|<xref:System.UInt32>|<xref:System.BitConverter.GetBytes%28System.UInt32%29>|<xref:System.BitConverter.ToUInt32%2A>|
87-
|<xref:System.UInt64>|<xref:System.BitConverter.GetBytes%28System.UInt64%29>|<xref:System.BitConverter.ToUInt64%2A>|
76+
| Type | To byte conversion | From byte conversion |
77+
|-----------------------|--------------------------------------------------------|-----------------------------------------|
78+
| <xref:System.Boolean> | <xref:System.BitConverter.GetBytes%28System.Boolean%29>| <xref:System.BitConverter.ToBoolean%2A> |
79+
| <xref:System.Char> | <xref:System.BitConverter.GetBytes%28System.Char%29> | <xref:System.BitConverter.ToChar%2A> |
80+
| <xref:System.Double> | <xref:System.BitConverter.GetBytes%28System.Double%29><br />-or-<br /><xref:System.BitConverter.DoubleToInt64Bits%28System.Double%29><br />-or-<br /><xref:System.BitConverter.DoubleToUInt64Bits%28System.Double%29> | <xref:System.BitConverter.ToDouble%2A><br />-or-<br /><xref:System.BitConverter.Int64BitsToDouble%2A><br />-or-<br /><xref:System.BitConverter.UInt64BitsToDouble%2A> |
81+
| <xref:System.Half> | <xref:System.BitConverter.GetBytes%28System.Half%29><br />-or-<br /><xref:System.BitConverter.HalfToInt16Bits%28System.Half%29><br />-or-<br /><xref:System.BitConverter.HalfToUInt16Bits%28System.Half%29> | <xref:System.BitConverter.ToHalf%2A><br />-or-<br /><xref:System.BitConverter.Int16BitsToHalf%2A><br />-or-<br /><xref:System.BitConverter.UInt16BitsToHalf%2A> |
82+
| <xref:System.Int16> | <xref:System.BitConverter.GetBytes%28System.Int16%29> | <xref:System.BitConverter.ToInt16%2A> |
83+
| <xref:System.Int32> | <xref:System.BitConverter.GetBytes%28System.Int32%29> | <xref:System.BitConverter.ToInt32%2A> |
84+
| <xref:System.Int64> | <xref:System.BitConverter.GetBytes%28System.Int64%29> | <xref:System.BitConverter.ToInt64%2A> |
85+
| <xref:System.Single> | <xref:System.BitConverter.GetBytes%28System.Single%29><br />-or-<br /><xref:System.BitConverter.SingleToInt32Bits%28System.Single%29><br />-or-<br /><xref:System.BitConverter.SingleToUInt32Bits%28System.Single%29> | <xref:System.BitConverter.ToSingle%2A><br />-or-<br /><xref:System.BitConverter.Int32BitsToSingle%2A><br />-or-<br /><xref:System.BitConverter.UInt32BitsToSingle%2A> |
86+
| <xref:System.UInt16> | <xref:System.BitConverter.GetBytes%28System.UInt16%29> | <xref:System.BitConverter.ToUInt16%2A> |
87+
| <xref:System.UInt32> | <xref:System.BitConverter.GetBytes%28System.UInt32%29> | <xref:System.BitConverter.ToUInt32%2A> |
88+
| <xref:System.UInt64> | <xref:System.BitConverter.GetBytes%28System.UInt64%29> | <xref:System.BitConverter.ToUInt64%2A> |
8889
8990
If you use <xref:System.BitConverter> methods to round-trip data, make sure that the <xref:System.BitConverter.GetBytes%2A> overload and the `To`*Type* method specify the same type. As the following example illustrates, restoring an array that represents a signed integer by calling the <xref:System.BitConverter.ToUInt32%2A> method can result in a value that is different from the original. For more information, see [Working with Signed Non-Decimal and Bitwise Values](/archive/blogs/bclteam/working-with-signed-non-decimal-and-bitwise-values-ron-petrusha).
9091

0 commit comments

Comments
 (0)