2
0

System.Runtime.CompilerServices.Unsafe.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. <?xml version="1.0" encoding="utf-8"?><doc>
  2. <assembly>
  3. <name>System.Runtime.CompilerServices.Unsafe</name>
  4. </assembly>
  5. <members>
  6. <member name="T:System.Runtime.CompilerServices.Unsafe">
  7. <summary>Contains generic, low-level functionality for manipulating pointers.</summary>
  8. </member>
  9. <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(``0@,System.Int32)">
  10. <summary>Adds an element offset to the given reference.</summary>
  11. <param name="source">The reference to add the offset to.</param>
  12. <param name="elementOffset">The offset to add.</param>
  13. <typeparam name="T">The type of reference.</typeparam>
  14. <returns>A new reference that reflects the addition of offset to pointer.</returns>
  15. </member>
  16. <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(``0@,System.IntPtr)">
  17. <summary>Adds an element offset to the given reference.</summary>
  18. <param name="source">The reference to add the offset to.</param>
  19. <param name="elementOffset">The offset to add.</param>
  20. <typeparam name="T">The type of reference.</typeparam>
  21. <returns>A new reference that reflects the addition of offset to pointer.</returns>
  22. </member>
  23. <member name="M:System.Runtime.CompilerServices.Unsafe.AddByteOffset``1(``0@,System.IntPtr)">
  24. <summary>Adds a byte offset to the given reference.</summary>
  25. <param name="source">The reference to add the offset to.</param>
  26. <param name="byteOffset">The offset to add.</param>
  27. <typeparam name="T">The type of reference.</typeparam>
  28. <returns>A new reference that reflects the addition of byte offset to pointer.</returns>
  29. </member>
  30. <member name="M:System.Runtime.CompilerServices.Unsafe.AreSame``1(``0@,``0@)">
  31. <summary>Determines whether the specified references point to the same location.</summary>
  32. <param name="left">The first reference to compare.</param>
  33. <param name="right">The second reference to compare.</param>
  34. <typeparam name="T">The type of reference.</typeparam>
  35. <returns>true if <paramref name="left">left</paramref> and <paramref name="right">right</paramref> point to the same location; otherwise, false.</returns>
  36. </member>
  37. <member name="M:System.Runtime.CompilerServices.Unsafe.As``1(System.Object)">
  38. <summary>Casts the given object to the specified type.</summary>
  39. <param name="o">The object to cast.</param>
  40. <typeparam name="T">The type which the object will be cast to.</typeparam>
  41. <returns>The original object, casted to the given type.</returns>
  42. </member>
  43. <member name="M:System.Runtime.CompilerServices.Unsafe.As``2(``0@)">
  44. <summary>Reinterprets the given reference as a reference to a value of type <typeparamref name="TTo">TTo</typeparamref>.</summary>
  45. <param name="source">The reference to reinterpret.</param>
  46. <typeparam name="TFrom">The type of reference to reinterpret..</typeparam>
  47. <typeparam name="TTo">The desired type of the reference.</typeparam>
  48. <returns>A reference to a value of type <typeparamref name="TTo">TTo</typeparamref>.</returns>
  49. </member>
  50. <member name="M:System.Runtime.CompilerServices.Unsafe.AsPointer``1(``0@)">
  51. <summary>Returns a pointer to the given by-ref parameter.</summary>
  52. <param name="value">The object whose pointer is obtained.</param>
  53. <typeparam name="T">The type of object.</typeparam>
  54. <returns>A pointer to the given value.</returns>
  55. </member>
  56. <member name="M:System.Runtime.CompilerServices.Unsafe.AsRef``1(System.Void*)">
  57. <summary>Reinterprets the given location as a reference to a value of type <typeparamref name="T">T</typeparamref>.</summary>
  58. <param name="source">The location of the value to reference.</param>
  59. <typeparam name="T">The type of the interpreted location.</typeparam>
  60. <returns>A reference to a value of type <typeparamref name="T">T</typeparamref>.</returns>
  61. </member>
  62. <member name="M:System.Runtime.CompilerServices.Unsafe.ByteOffset``1(``0@,``0@)">
  63. <summary>Determines the byte offset from origin to target from the given references.</summary>
  64. <param name="origin">The reference to origin.</param>
  65. <param name="target">The reference to target.</param>
  66. <typeparam name="T">The type of reference.</typeparam>
  67. <returns>Byte offset from origin to target i.e. <paramref name="target">target</paramref> - <paramref name="origin">origin</paramref>.</returns>
  68. </member>
  69. <member name="M:System.Runtime.CompilerServices.Unsafe.Copy``1(System.Void*,``0@)">
  70. <summary>Copies a value of type <typeparamref name="T">T</typeparamref> to the given location.</summary>
  71. <param name="destination">The location to copy to.</param>
  72. <param name="source">A reference to the value to copy.</param>
  73. <typeparam name="T">The type of value to copy.</typeparam>
  74. </member>
  75. <member name="M:System.Runtime.CompilerServices.Unsafe.Copy``1(``0@,System.Void*)">
  76. <summary>Copies a value of type <typeparamref name="T">T</typeparamref> to the given location.</summary>
  77. <param name="destination">The location to copy to.</param>
  78. <param name="source">A pointer to the value to copy.</param>
  79. <typeparam name="T">The type of value to copy.</typeparam>
  80. </member>
  81. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlock(System.Byte@,System.Byte@,System.UInt32)">
  82. <summary>Copies bytes from the source address to the destination address.</summary>
  83. <param name="destination">The destination address to copy to.</param>
  84. <param name="source">The source address to copy from.</param>
  85. <param name="byteCount">The number of bytes to copy.</param>
  86. </member>
  87. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlock(System.Void*,System.Void*,System.UInt32)">
  88. <summary>Copies bytes from the source address to the destination address.</summary>
  89. <param name="destination">The destination address to copy to.</param>
  90. <param name="source">The source address to copy from.</param>
  91. <param name="byteCount">The number of bytes to copy.</param>
  92. </member>
  93. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Void*,System.Void*,System.UInt32)">
  94. <summary>Copies bytes from the source address to the destination address
  95. without assuming architecture dependent alignment of the addresses.</summary>
  96. <param name="destination">The destination address to copy to.</param>
  97. <param name="source">The source address to copy from.</param>
  98. <param name="byteCount">The number of bytes to copy.</param>
  99. </member>
  100. <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Byte@,System.Byte@,System.UInt32)">
  101. <summary>Copies bytes from the source address to the destination address
  102. without assuming architecture dependent alignment of the addresses.</summary>
  103. <param name="destination">The destination address to copy to.</param>
  104. <param name="source">The source address to copy from.</param>
  105. <param name="byteCount">The number of bytes to copy.</param>
  106. </member>
  107. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Byte@,System.Byte,System.UInt32)">
  108. <summary>Initializes a block of memory at the given location with a given initial value.</summary>
  109. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  110. <param name="value">The value to initialize the block to.</param>
  111. <param name="byteCount">The number of bytes to initialize.</param>
  112. </member>
  113. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Void*,System.Byte,System.UInt32)">
  114. <summary>Initializes a block of memory at the given location with a given initial value.</summary>
  115. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  116. <param name="value">The value to initialize the block to.</param>
  117. <param name="byteCount">The number of bytes to initialize.</param>
  118. </member>
  119. <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Byte@,System.Byte,System.UInt32)">
  120. <summary>Initializes a block of memory at the given location with a given initial value
  121. without assuming architecture dependent alignment of the address.</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.InitBlockUnaligned(System.Void*,System.Byte,System.UInt32)">
  127. <summary>Initializes a block of memory at the given location with a given initial value
  128. without assuming architecture dependent alignment of the address.</summary>
  129. <param name="startAddress">The address of the start of the memory block to initialize.</param>
  130. <param name="value">The value to initialize the block to.</param>
  131. <param name="byteCount">The number of bytes to initialize.</param>
  132. </member>
  133. <member name="M:System.Runtime.CompilerServices.Unsafe.Read``1(System.Void*)">
  134. <summary>Reads a value of type <typeparamref name="T">T</typeparamref> from the given location.</summary>
  135. <param name="source">The location to read from.</param>
  136. <typeparam name="T">The type to read.</typeparam>
  137. <returns>An object of type <typeparamref name="T">T</typeparamref> read from the given location.</returns>
  138. </member>
  139. <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Byte@)">
  140. <summary>Reads a value of type <typeparamref name="T">T</typeparamref> from the given location
  141. without assuming architecture dependent alignment of the addresses.</summary>
  142. <param name="source">The location to read from.</param>
  143. <typeparam name="T">The type to read.</typeparam>
  144. <returns>An object of type <typeparamref name="T">T</typeparamref> read from the given location.</returns>
  145. </member>
  146. <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Void*)">
  147. <summary>Reads a value of type <typeparamref name="T">T</typeparamref> from the given location
  148. without assuming architecture dependent alignment of the addresses.</summary>
  149. <param name="source">The location to read from.</param>
  150. <typeparam name="T">The type to read.</typeparam>
  151. <returns>An object of type <typeparamref name="T">T</typeparamref> read from the given location.</returns>
  152. </member>
  153. <member name="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1">
  154. <summary>Returns the size of an object of the given type parameter.</summary>
  155. <typeparam name="T">The type of object whose size is retrieved.</typeparam>
  156. <returns>The size of an object of type <typeparamref name="T">T</typeparamref>.</returns>
  157. </member>
  158. <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.Int32)">
  159. <summary>Subtracts an element offset from the given reference.</summary>
  160. <param name="source">The reference to subtract the offset from.</param>
  161. <param name="elementOffset">The offset to subtract.</param>
  162. <typeparam name="T">The type of reference.</typeparam>
  163. <returns>A new reference that reflects the subraction of offset from pointer.</returns>
  164. </member>
  165. <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.IntPtr)">
  166. <summary>Subtracts an element offset from the given reference.</summary>
  167. <param name="source">The reference to subtract the offset from.</param>
  168. <param name="elementOffset">The offset to subtract.</param>
  169. <typeparam name="T">The type of reference.</typeparam>
  170. <returns>A new reference that reflects the subraction of offset from pointer.</returns>
  171. </member>
  172. <member name="M:System.Runtime.CompilerServices.Unsafe.SubtractByteOffset``1(``0@,System.IntPtr)">
  173. <summary>Subtracts a byte offset from the given reference.</summary>
  174. <param name="source">The reference to subtract the offset from.</param>
  175. <param name="byteOffset"></param>
  176. <typeparam name="T">The type of reference.</typeparam>
  177. <returns>A new reference that reflects the subraction of byte offset from pointer.</returns>
  178. </member>
  179. <member name="M:System.Runtime.CompilerServices.Unsafe.Write``1(System.Void*,``0)">
  180. <summary>Writes a value of type <typeparamref name="T">T</typeparamref> to the given location.</summary>
  181. <param name="destination">The location to write to.</param>
  182. <param name="value">The value to write.</param>
  183. <typeparam name="T">The type of value to write.</typeparam>
  184. </member>
  185. <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Byte@,``0)">
  186. <summary>Writes a value of type <typeparamref name="T">T</typeparamref> to the given location
  187. without assuming architecture dependent alignment of the addresses.</summary>
  188. <param name="destination">The location to write to.</param>
  189. <param name="value">The value to write.</param>
  190. <typeparam name="T">The type of value to write.</typeparam>
  191. </member>
  192. <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Void*,``0)">
  193. <summary>Writes a value of type <typeparamref name="T">T</typeparamref> to the given location
  194. without assuming architecture dependent alignment of the addresses.</summary>
  195. <param name="destination">The location to write to.</param>
  196. <param name="value">The value to write.</param>
  197. <typeparam name="T">The type of value to write.</typeparam>
  198. </member>
  199. </members>
  200. </doc>