No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

System.Runtime.CompilerServices.Unsafe.xml 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Runtime.CompilerServices.Unsafe</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Runtime.CompilerServices.Unsafe">
  8. <summary>Contains generic, low-level functionality for manipulating pointers.</summary>
  9. </member>
  10. <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(``0@,System.Int32)">
  11. <summary>Adds an element offset to the given reference.</summary>
  12. <param name="source">The reference to add the offset to.</param>
  13. <param name="elementOffset">The offset to add.</param>
  14. <typeparam name="T">The type of reference.</typeparam>
  15. <returns>A new reference that reflects the addition of offset to pointer.</returns>
  16. </member>
  17. <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(``0@,System.IntPtr)">
  18. <summary>Adds an element offset to the given reference.</summary>
  19. <param name="source">The reference to add the offset to.</param>
  20. <param name="elementOffset">The offset to add.</param>
  21. <typeparam name="T">The type of reference.</typeparam>
  22. <returns>A new reference that reflects the addition of offset to pointer.</returns>
  23. </member>
  24. <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(System.Void*,System.Int32)">
  25. <summary>Adds an element offset to the given void pointer.</summary>
  26. <param name="source">The void pointer to add the offset to.</param>
  27. <param name="elementOffset">The offset to add.</param>
  28. <typeparam name="T">The type of void pointer.</typeparam>
  29. <returns>A new void pointer that reflects the addition of offset to the specified pointer.</returns>
  30. </member>
  31. <member name="M:System.Runtime.CompilerServices.Unsafe.AddByteOffset``1(``0@,System.IntPtr)">
  32. <summary>Adds a byte offset to the given reference.</summary>
  33. <param name="source">The reference to add the offset to.</param>
  34. <param name="byteOffset">The offset to add.</param>
  35. <typeparam name="T">The type of reference.</typeparam>
  36. <returns>A new reference that reflects the addition of byte offset to pointer.</returns>
  37. </member>
  38. <member name="M:System.Runtime.CompilerServices.Unsafe.AreSame``1(``0@,``0@)">
  39. <summary>Determines whether the specified references point to the same location.</summary>
  40. <param name="left">The first reference to compare.</param>
  41. <param name="right">The second reference to compare.</param>
  42. <typeparam name="T">The type of reference.</typeparam>
  43. <returns>
  44. <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> point to the same location; otherwise, <see langword="false" />.</returns>
  45. </member>
  46. <member name="M:System.Runtime.CompilerServices.Unsafe.As``1(System.Object)">
  47. <summary>Casts the given object to the specified type.</summary>
  48. <param name="o">The object to cast.</param>
  49. <typeparam name="T">The type which the object will be cast to.</typeparam>
  50. <returns>The original object, casted to the given type.</returns>
  51. </member>
  52. <member name="M:System.Runtime.CompilerServices.Unsafe.As``2(``0@)">
  53. <summary>Reinterprets the given reference as a reference to a value of type <typeparamref name="TTo" />.</summary>
  54. <param name="source">The reference to reinterpret.</param>
  55. <typeparam name="TFrom">The type of reference to reinterpret.</typeparam>
  56. <typeparam name="TTo">The desired type of the reference.</typeparam>
  57. <returns>A reference to a value of type <typeparamref name="TTo" />.</returns>
  58. </member>
  59. <member name="M:System.Runtime.CompilerServices.Unsafe.AsPointer``1(``0@)">
  60. <summary>Returns a pointer to the given by-ref parameter.</summary>
  61. <param name="value">The object whose pointer is obtained.</param>
  62. <typeparam name="T">The type of object.</typeparam>
  63. <returns>A pointer to the given value.</returns>
  64. </member>
  65. <member name="M:System.Runtime.CompilerServices.Unsafe.AsRef``1(``0@)">
  66. <summary>Reinterprets the given read-only reference as a reference.</summary>
  67. <param name="source">The read-only reference to reinterpret.</param>
  68. <typeparam name="T">The type of reference.</typeparam>
  69. <returns>A reference to a value of type <typeparamref name="T" />.</returns>
  70. </member>
  71. <member name="M:System.Runtime.CompilerServices.Unsafe.AsRef``1(System.Void*)">
  72. <summary>Reinterprets the given location as a reference to a value of type <typeparamref name="T" />.</summary>
  73. <param name="source">The location of the value to reference.</param>
  74. <typeparam name="T">The type of the interpreted location.</typeparam>
  75. <returns>A reference to a value of type <typeparamref name="T" />.</returns>
  76. </member>
  77. <member name="M:System.Runtime.CompilerServices.Unsafe.ByteOffset``1(``0@,``0@)">
  78. <summary>Determines the byte offset from origin to target from the given references.</summary>
  79. <param name="origin">The reference to origin.</param>
  80. <param name="target">The reference to target.</param>
  81. <typeparam name="T">The type of reference.</typeparam>
  82. <returns>Byte offset from origin to target i.e. <paramref name="target" /> - <paramref name="origin" />.</returns>
  83. </member>
  84. <member name="M:System.Runtime.CompilerServices.Unsafe.Copy``1(``0@,System.Void*)">
  85. <summary>Copies a value of type <typeparamref name="T" /> to the given location.</summary>
  86. <param name="destination">The location to copy to.</param>
  87. <param name="source">A pointer to the value to copy.</param>
  88. <typeparam name="T">The type of value to copy.</typeparam>
  89. </member>
  90. <member name="M:System.Runtime.CompilerServices.Unsafe.Copy``1(System.Void*,``0@)">
  91. <summary>Copies a value of type <typeparamref name="T" /> to the given location.</summary>
  92. <param name="destination">The location to copy to.</param>
  93. <param name="source">A reference to the value to copy.</param>
  94. <typeparam name="T">The type of value to copy.</typeparam>
  95. </member>
  96. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlock(System.Byte@,System.Byte@,System.UInt32)">
  97. <summary>Copies bytes from the source address to the destination address.</summary>
  98. <param name="destination">The destination address to copy to.</param>
  99. <param name="source">The source address to copy from.</param>
  100. <param name="byteCount">The number of bytes to copy.</param>
  101. </member>
  102. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlock(System.Void*,System.Void*,System.UInt32)">
  103. <summary>Copies bytes from the source address to the destination address.</summary>
  104. <param name="destination">The destination address to copy to.</param>
  105. <param name="source">The source address to copy from.</param>
  106. <param name="byteCount">The number of bytes to copy.</param>
  107. </member>
  108. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Byte@,System.Byte@,System.UInt32)">
  109. <summary>Copies bytes from the source address to the destination address without assuming architecture dependent alignment of the addresses.</summary>
  110. <param name="destination">The destination address to copy to.</param>
  111. <param name="source">The source address to copy from.</param>
  112. <param name="byteCount">The number of bytes to copy.</param>
  113. </member>
  114. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Void*,System.Void*,System.UInt32)">
  115. <summary>Copies bytes from the source address to the destination address without assuming architecture dependent alignment of the addresses.</summary>
  116. <param name="destination">The destination address to copy to.</param>
  117. <param name="source">The source address to copy from.</param>
  118. <param name="byteCount">The number of bytes to copy.</param>
  119. </member>
  120. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Byte@,System.Byte,System.UInt32)">
  121. <summary>Initializes a block of memory at the given location with a given initial value.</summary>
  122. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  123. <param name="value">The value to initialize the block to.</param>
  124. <param name="byteCount">The number of bytes to initialize.</param>
  125. </member>
  126. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Void*,System.Byte,System.UInt32)">
  127. <summary>Initializes a block of memory at the given location with a given initial value.</summary>
  128. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  129. <param name="value">The value to initialize the block to.</param>
  130. <param name="byteCount">The number of bytes to initialize.</param>
  131. </member>
  132. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Byte@,System.Byte,System.UInt32)">
  133. <summary>Initializes a block of memory at the given location with a given initial value without assuming architecture dependent alignment of the address.</summary>
  134. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  135. <param name="value">The value to initialize the block to.</param>
  136. <param name="byteCount">The number of bytes to initialize.</param>
  137. </member>
  138. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Void*,System.Byte,System.UInt32)">
  139. <summary>Initializes a block of memory at the given location with a given initial value without assuming architecture dependent alignment of the address.</summary>
  140. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  141. <param name="value">The value to initialize the block to.</param>
  142. <param name="byteCount">The number of bytes to initialize.</param>
  143. </member>
  144. <member name="M:System.Runtime.CompilerServices.Unsafe.IsAddressGreaterThan``1(``0@,``0@)">
  145. <summary>Returns a value that indicates whether a specified reference is greater than another specified reference.</summary>
  146. <param name="left">The first value to compare.</param>
  147. <param name="right">The second value to compare.</param>
  148. <typeparam name="T">The type of the reference.</typeparam>
  149. <returns>
  150. <see langword="true" /> if <paramref name="left" /> is greater than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
  151. </member>
  152. <member name="M:System.Runtime.CompilerServices.Unsafe.IsAddressLessThan``1(``0@,``0@)">
  153. <summary>Returns a value that indicates whether a specified reference is less than another specified reference.</summary>
  154. <param name="left">The first value to compare.</param>
  155. <param name="right">The second value to compare.</param>
  156. <typeparam name="T">The type of the reference.</typeparam>
  157. <returns>
  158. <see langword="true" /> if <paramref name="left" /> is less than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
  159. </member>
  160. <member name="M:System.Runtime.CompilerServices.Unsafe.IsNullRef``1(``0@)">
  161. <param name="source" />
  162. <typeparam name="T" />
  163. </member>
  164. <member name="M:System.Runtime.CompilerServices.Unsafe.NullRef``1">
  165. <typeparam name="T" />
  166. </member>
  167. <member name="M:System.Runtime.CompilerServices.Unsafe.Read``1(System.Void*)">
  168. <summary>Reads a value of type <typeparamref name="T" /> from the given location.</summary>
  169. <param name="source">The location to read from.</param>
  170. <typeparam name="T">The type to read.</typeparam>
  171. <returns>An object of type <typeparamref name="T" /> read from the given location.</returns>
  172. </member>
  173. <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Byte@)">
  174. <summary>Reads a value of type <typeparamref name="T" /> from the given location without assuming architecture dependent alignment of the addresses.</summary>
  175. <param name="source">The location to read from.</param>
  176. <typeparam name="T">The type to read.</typeparam>
  177. <returns>An object of type <typeparamref name="T" /> read from the given location.</returns>
  178. </member>
  179. <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Void*)">
  180. <summary>Reads a value of type <typeparamref name="T" /> from the given location without assuming architecture dependent alignment of the addresses.</summary>
  181. <param name="source">The location to read from.</param>
  182. <typeparam name="T">The type to read.</typeparam>
  183. <returns>An object of type <typeparamref name="T" /> read from the given location.</returns>
  184. </member>
  185. <member name="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1">
  186. <summary>Returns the size of an object of the given type parameter.</summary>
  187. <typeparam name="T">The type of object whose size is retrieved.</typeparam>
  188. <returns>The size of an object of type <typeparamref name="T" />.</returns>
  189. </member>
  190. <member name="M:System.Runtime.CompilerServices.Unsafe.SkipInit``1(``0@)">
  191. <summary>Bypasses definite assignment rules for a given value.</summary>
  192. <param name="value">The uninitialized object.</param>
  193. <typeparam name="T">The type of the uninitialized object.</typeparam>
  194. </member>
  195. <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.Int32)">
  196. <summary>Subtracts an element offset from the given reference.</summary>
  197. <param name="source">The reference to subtract the offset from.</param>
  198. <param name="elementOffset">The offset to subtract.</param>
  199. <typeparam name="T">The type of reference.</typeparam>
  200. <returns>A new reference that reflects the subtraction of offset from pointer.</returns>
  201. </member>
  202. <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.IntPtr)">
  203. <summary>Subtracts an element offset from the given reference.</summary>
  204. <param name="source">The reference to subtract the offset from.</param>
  205. <param name="elementOffset">The offset to subtract.</param>
  206. <typeparam name="T">The type of reference.</typeparam>
  207. <returns>A new reference that reflects the subtraction of offset from pointer.</returns>
  208. </member>
  209. <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(System.Void*,System.Int32)">
  210. <summary>Subtracts an element offset from the given void pointer.</summary>
  211. <param name="source">The void pointer to subtract the offset from.</param>
  212. <param name="elementOffset">The offset to subtract.</param>
  213. <typeparam name="T">The type of the void pointer.</typeparam>
  214. <returns>A new void pointer that reflects the subtraction of offset from the specified pointer.</returns>
  215. </member>
  216. <member name="M:System.Runtime.CompilerServices.Unsafe.SubtractByteOffset``1(``0@,System.IntPtr)">
  217. <summary>Subtracts a byte offset from the given reference.</summary>
  218. <param name="source">The reference to subtract the offset from.</param>
  219. <param name="byteOffset">The offset to subtract.</param>
  220. <typeparam name="T">The type of reference.</typeparam>
  221. <returns>A new reference that reflects the subtraction of byte offset from pointer.</returns>
  222. </member>
  223. <member name="M:System.Runtime.CompilerServices.Unsafe.Unbox``1(System.Object)">
  224. <summary>Returns a <see langword="mutable ref" /> to a boxed value.</summary>
  225. <param name="box">The value to unbox.</param>
  226. <typeparam name="T">The type to be unboxed.</typeparam>
  227. <exception cref="T:System.NullReferenceException">
  228. <paramref name="box" /> is <see langword="null" />, and <typeparamref name="T" /> is a non-nullable value type.</exception>
  229. <exception cref="T:System.InvalidCastException">
  230. <paramref name="box" /> is not a boxed value type.
  231. -or-
  232. <paramref name="box" /> is not a boxed <typeparamref name="T" />.</exception>
  233. <exception cref="T:System.TypeLoadException">
  234. <typeparamref name="T" /> cannot be found.</exception>
  235. <returns>A <see langword="mutable ref" /> to the boxed value <paramref name="box" />.</returns>
  236. </member>
  237. <member name="M:System.Runtime.CompilerServices.Unsafe.Write``1(System.Void*,``0)">
  238. <summary>Writes a value of type <typeparamref name="T" /> to the given location.</summary>
  239. <param name="destination">The location to write to.</param>
  240. <param name="value">The value to write.</param>
  241. <typeparam name="T">The type of value to write.</typeparam>
  242. </member>
  243. <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Byte@,``0)">
  244. <summary>Writes a value of type <typeparamref name="T" /> to the given location without assuming architecture dependent alignment of the addresses.</summary>
  245. <param name="destination">The location to write to.</param>
  246. <param name="value">The value to write.</param>
  247. <typeparam name="T">The type of value to write.</typeparam>
  248. </member>
  249. <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Void*,``0)">
  250. <summary>Writes a value of type <typeparamref name="T" /> to the given location without assuming architecture dependent alignment of the addresses.</summary>
  251. <param name="destination">The location to write to.</param>
  252. <param name="value">The value to write.</param>
  253. <typeparam name="T">The type of value to write.</typeparam>
  254. </member>
  255. </members>
  256. </doc>