1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Runtime.CompilerServices.Unsafe</name>
7 <member name="T:System.Runtime.CompilerServices.Unsafe">
8 <summary>Contains generic, low-level functionality for manipulating pointers.</summary>
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>
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>
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>
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>
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>
44 <see langword="true" /> if <paramref name="left" /> and <paramref name="right" /> point to the same location; otherwise, <see langword="false" />.</returns>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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
110 without assuming architecture dependent alignment of the addresses.</summary>
111 <param name="destination">The destination address to copy to.</param>
112 <param name="source">The source address to copy from.</param>
113 <param name="byteCount">The number of bytes to copy.</param>
115 <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Void*,System.Void*,System.UInt32)">
116 <summary>Copies bytes from the source address to the destination address
117 without assuming architecture dependent alignment of the addresses.</summary>
118 <param name="destination">The destination address to copy to.</param>
119 <param name="source">The source address to copy from.</param>
120 <param name="byteCount">The number of bytes to copy.</param>
122 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Byte@,System.Byte,System.UInt32)">
123 <summary>Initializes a block of memory at the given location with a given initial value.</summary>
124 <param name="startAddress">The address of the start of the memory block to initialize.</param>
125 <param name="value">The value to initialize the block to.</param>
126 <param name="byteCount">The number of bytes to initialize.</param>
128 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Void*,System.Byte,System.UInt32)">
129 <summary>Initializes a block of memory at the given location with a given initial value.</summary>
130 <param name="startAddress">The address of the start of the memory block to initialize.</param>
131 <param name="value">The value to initialize the block to.</param>
132 <param name="byteCount">The number of bytes to initialize.</param>
134 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Byte@,System.Byte,System.UInt32)">
135 <summary>Initializes a block of memory at the given location with a given initial value
136 without assuming architecture dependent alignment of the address.</summary>
137 <param name="startAddress">The address of the start of the memory block to initialize.</param>
138 <param name="value">The value to initialize the block to.</param>
139 <param name="byteCount">The number of bytes to initialize.</param>
141 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Void*,System.Byte,System.UInt32)">
142 <summary>Initializes a block of memory at the given location with a given initial value
143 without assuming architecture dependent alignment of the address.</summary>
144 <param name="startAddress">The address of the start of the memory block to initialize.</param>
145 <param name="value">The value to initialize the block to.</param>
146 <param name="byteCount">The number of bytes to initialize.</param>
148 <member name="M:System.Runtime.CompilerServices.Unsafe.IsAddressGreaterThan``1(``0@,``0@)">
149 <summary>Returns a value that indicates whether a specified reference is greater than another specified reference.</summary>
150 <param name="left">The first value to compare.</param>
151 <param name="right">The second value to compare.</param>
152 <typeparam name="T">The type of the reference.</typeparam>
154 <see langword="true" /> if <paramref name="left" /> is greater than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
156 <member name="M:System.Runtime.CompilerServices.Unsafe.IsAddressLessThan``1(``0@,``0@)">
157 <summary>Returns a value that indicates whether a specified reference is less than another specified reference.</summary>
158 <param name="left">The first value to compare.</param>
159 <param name="right">The second value to compare.</param>
160 <typeparam name="T">The type of the reference.</typeparam>
162 <see langword="true" /> if <paramref name="left" /> is less than <paramref name="right" />; otherwise, <see langword="false" />.</returns>
164 <member name="M:System.Runtime.CompilerServices.Unsafe.Read``1(System.Void*)">
165 <summary>Reads a value of type <typeparamref name="T" /> from the given location.</summary>
166 <param name="source">The location to read from.</param>
167 <typeparam name="T">The type to read.</typeparam>
168 <returns>An object of type <typeparamref name="T" /> read from the given location.</returns>
170 <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Byte@)">
171 <summary>Reads a value of type <typeparamref name="T" /> from the given location
172 without assuming architecture dependent alignment of the addresses.</summary>
173 <param name="source">The location to read from.</param>
174 <typeparam name="T">The type to read.</typeparam>
175 <returns>An object of type <typeparamref name="T" /> read from the given location.</returns>
177 <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Void*)">
178 <summary>Reads a value of type <typeparamref name="T" /> from the given location
179 without assuming architecture dependent alignment of the addresses.</summary>
180 <param name="source">The location to read from.</param>
181 <typeparam name="T">The type to read.</typeparam>
182 <returns>An object of type <typeparamref name="T" /> read from the given location.</returns>
184 <member name="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1">
185 <summary>Returns the size of an object of the given type parameter.</summary>
186 <typeparam name="T">The type of object whose size is retrieved.</typeparam>
187 <returns>The size of an object of type <typeparamref name="T" />.</returns>
189 <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.Int32)">
190 <summary>Subtracts an element offset from the given reference.</summary>
191 <param name="source">The reference to subtract the offset from.</param>
192 <param name="elementOffset">The offset to subtract.</param>
193 <typeparam name="T">The type of reference.</typeparam>
194 <returns>A new reference that reflects the subtraction of offset from pointer.</returns>
196 <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.IntPtr)">
197 <summary>Subtracts an element offset from the given reference.</summary>
198 <param name="source">The reference to subtract the offset from.</param>
199 <param name="elementOffset">The offset to subtract.</param>
200 <typeparam name="T">The type of reference.</typeparam>
201 <returns>A new reference that reflects the subtraction of offset from pointer.</returns>
203 <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(System.Void*,System.Int32)">
204 <summary>Subtracts an element offset from the given void pointer.</summary>
205 <param name="source">The void pointer to subtract the offset from.</param>
206 <param name="elementOffset">The offset to subtract.</param>
207 <typeparam name="T">The type of the void pointer.</typeparam>
208 <returns>A new void pointer that reflects the subtraction of offset from the specified pointer.</returns>
210 <member name="M:System.Runtime.CompilerServices.Unsafe.SubtractByteOffset``1(``0@,System.IntPtr)">
211 <summary>Subtracts a byte offset from the given reference.</summary>
212 <param name="source">The reference to subtract the offset from.</param>
213 <param name="byteOffset">The offset to subtract.</param>
214 <typeparam name="T">The type of reference.</typeparam>
215 <returns>A new reference that reflects the subtraction of byte offset from pointer.</returns>
217 <member name="M:System.Runtime.CompilerServices.Unsafe.Unbox``1(System.Object)">
218 <summary>Returns a <see langword="mutable ref" /> to a boxed value.</summary>
219 <param name="box">The value to unbox.</param>
220 <typeparam name="T">The type to be unboxed.</typeparam>
221 <returns>A <see langword="mutable ref" /> to the boxed value <paramref name="box" />.</returns>
222 <exception cref="T:System.NullReferenceException">
223 <paramref name="box" /> is <see langword="null" />, and <typeparamref name="T" /> is a non-nullable value type.</exception>
224 <exception cref="T:System.InvalidCastException">
225 <paramref name="box" /> is not a boxed value type.
227 <paramref name="box" /> is not a boxed <typeparamref name="T" />.</exception>
228 <exception cref="T:System.TypeLoadException">
229 <typeparamref name="T" /> cannot be found.</exception>
231 <member name="M:System.Runtime.CompilerServices.Unsafe.Write``1(System.Void*,``0)">
232 <summary>Writes a value of type <typeparamref name="T" /> to the given location.</summary>
233 <param name="destination">The location to write to.</param>
234 <param name="value">The value to write.</param>
235 <typeparam name="T">The type of value to write.</typeparam>
237 <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Byte@,``0)">
238 <summary>Writes a value of type <typeparamref name="T" /> to the given location
239 without assuming architecture dependent alignment of the addresses.</summary>
240 <param name="destination">The location to write to.</param>
241 <param name="value">The value to write.</param>
242 <typeparam name="T">The type of value to write.</typeparam>
244 <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Void*,``0)">
245 <summary>Writes a value of type <typeparamref name="T" /> to the given location
246 without assuming architecture dependent alignment of the addresses.</summary>
247 <param name="destination">The location to write to.</param>
248 <param name="value">The value to write.</param>
249 <typeparam name="T">The type of value to write.</typeparam>