1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="RuntimeHelpers" FullName="System.Runtime.CompilerServices.RuntimeHelpers" FullNameSP="System_Runtime_CompilerServices_RuntimeHelpers" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public sealed serializable RuntimeHelpers extends System.Object" />
<TypeSignature Language="C#" Value="public static class RuntimeHelpers" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit RuntimeHelpers extends System.Object" />
<MemberOfLibrary>RuntimeInfrastructure</MemberOfLibrary>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<para>
<block subset="none" type="note">The types in
<see langword="System.Runtime.CompilerServices" />
are intended primarily for use by compilers, not application
programmers. They allow compilers to easily implement certain language
features that are not directly visible to programmers.</block>
</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a set of static methods and properties that provide support for compilers. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName="EnsureSufficientExecutionStack">
<MemberSignature Language="C#" Value="public static void EnsureSufficientExecutionStack ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void EnsureSufficientExecutionStack() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.WillNotCorruptState, System.Runtime.ConstrainedExecution.Cer.Success)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.EnsureSufficientExecutionStack" /> provides information about an artificially limited stack that preserves enough space for an exception to be raised and recovery action to be taken. The artificial stack limit is chosen by the common language runtime to ensure that enough space remains to throw an exception safely.</para>
<para>This method is useful in situations where stack overflow might occur as a result of unbounded recursion. It is intended for use in compiler services scenarios, although it can also be used safely in other development scenarios.</para>
<para>If the stack space is sufficient, the exception is not thrown, and most .NET Framework types and members can still be called.</para>
<block subset="none" type="note">
<para>This method is not part of the constrained execution region (CER) support, and should not be confused with the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.ProbeForSufficientStack" /> method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Ensures that the remaining stack space is large enough to execute the average .NET Framework function.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public static bool Equals (object o1, object o2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool Equals(object o1, object o2) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o1" Type="System.Object" />
<Parameter Name="o2" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by compilers.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Determines whether the specified <see cref="T:System.Object" /> instances are considered equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the <paramref name="o1" /> parameter is the same instance as the <paramref name="o2" /> parameter, or if both are null, or if o1.Equals(o2) returns true; otherwise, false.</para>
</returns>
<param name="o1">
<attribution license="cc4" from="Microsoft" modified="false" />The first object to compare. </param>
<param name="o2">
<attribution license="cc4" from="Microsoft" modified="false" />The second object to compare. </param>
</Docs>
</Member>
<Member MemberName="ExecuteCodeWithGuaranteedCleanup">
<MemberSignature Language="C#" Value="public static void ExecuteCodeWithGuaranteedCleanup (System.Runtime.CompilerServices.RuntimeHelpers.TryCode code, System.Runtime.CompilerServices.RuntimeHelpers.CleanupCode backoutCode, object userData);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void ExecuteCodeWithGuaranteedCleanup(class System.Runtime.CompilerServices.RuntimeHelpers/TryCode code, class System.Runtime.CompilerServices.RuntimeHelpers/CleanupCode backoutCode, object userData) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="code" Type="System.Runtime.CompilerServices.RuntimeHelpers+TryCode" />
<Parameter Name="backoutCode" Type="System.Runtime.CompilerServices.RuntimeHelpers+CleanupCode" />
<Parameter Name="userData" Type="System.Object" />
</Parameters>
<Docs>
<param name="code">To be added.</param>
<param name="backoutCode">To be added.</param>
<param name="userData">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public static int GetHashCode (object o);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 GetHashCode(object o) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> method always calls the <see cref="M:System.Object.GetHashCode" /> method non-virtually, even if the object's type has overridden the <see cref="M:System.Object.GetHashCode" /> method. Therefore, using <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> might differ from calling GetHashCode directly on the object with the <see cref="M:System.Object.GetHashCode" /> method.</para>
<block subset="none" type="note">
<para>Although the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> method returns identical hash codes for identical object references, you should not use this method to test for object identity, because this hash code does not uniquely identify an object reference. To test for object identify (that is, to test that two objects reference the same object in memory), call the <see cref="M:System.Object.ReferenceEquals(System.Object,System.Object)" /> method. Nor should you use <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> to test whether two strings represent equal object references, because the string is interned. To test for string interning, call the <see cref="M:System.String.IsInterned(System.String)" /> method. </para>
</block>
<para>The <see cref="M:System.Object.GetHashCode" /> and <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> methods differ as follows:</para>
<list type="bullet">
<item>
<para>
<see cref="M:System.Object.GetHashCode" /> returns a hash code that is based on the object's definition of equality. For example, two strings with identical contents will return the same value for <see cref="M:System.Object.GetHashCode" />.</para>
</item>
<item>
<para>
<see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> returns a hash code that indicates object identity. That is, two string variables whose contents are identical and that represent a string that is interned (see the <format type="text/html"><a href="#interning">String Interning</a></format> section) or that represent a single string in memory return identical hash codes. </para>
</item>
</list>
<block subset="none" type="note">
<para>Note that <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> always returns identical hash codes for equal object references. However, the reverse is not true: equal hash codes do not indicate equal object references. A particular hash code value is not unique to a particular object reference; different object references can generate identical hash codes. </para>
</block>
<para>This method is used by compilers.</para>
<format type="text/html">
<a href="#interning" />
</format>
<format type="text/html">
<h2>String Interning</h2>
</format>
<para>The common language runtime (CLR) maintains an internal pool of strings and stores literals in the pool. If two strings (for example, str1 and str2) are formed from an identical string literal, the CLR will set str1 and str2 to point to the same location on the managed heap to conserve memory. Calling <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> on these two string objects will produce the same hash code, contrary to the second bulleted item in the previous section.</para>
<para>The CLR adds only literals to the pool. Results of string operations such as concatenation are not added to the pool, unless the compiler resolves the string concatenation as a single string literal. Therefore, if str2 was created as the result of a concatenation operation, and str2 is identical to str1, using <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)" /> on these two string objects will not produce the same hash code.</para>
<para>If you want to add a concatenated string to the pool explicitly, use the <see cref="M:System.String.Intern(System.String)" /> method.</para>
<para>You can also use the <see cref="M:System.String.IsInterned(System.String)" /> method to check whether a string has an interned reference.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Serves as a hash function for a particular object, and is suitable for use in algorithms and data structures that use hash codes, such as a hash table.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A hash code for the object identified by the <paramref name="o" /> parameter.</para>
</returns>
<param name="o">
<attribution license="cc4" from="Microsoft" modified="false" />An object to retrieve the hash code for. </param>
</Docs>
</Member>
<Member MemberName="GetObjectValue">
<MemberSignature Language="C#" Value="public static object GetObjectValue (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object GetObjectValue(object obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Boxing a value type creates an object and performs a shallow copy of the fields of the specified value type into the new object.</para>
<para>This method allows a value class to be manipulated as an object while it retains the aliasing behavior of a value class. </para>
<para>The return value depends on whether the value class is mutable or immutable:</para>
<list type="bullet">
<item>
<para>If the value being assigned is a mutable value class, the method returns a shallow copy of the class, because value classes have copy semantics.</para>
</item>
<item>
<para>If the value being assigned is an immutable value class, the method returns the object itself, instead of a copy of the class.</para>
</item>
</list>
<para>Compilers of dynamically typed languages can use this method to make sure that boxed value types work identically to unboxed value types. That is, boxed value types get cloned when you pass them around, and they are always passed by value. The compiler can call <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetObjectValue(System.Object)" /> to assign a value type to an object or to pass a value type as a parameter of a type object.</para>
<para>This method is used by compilers.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Boxes a value type.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A boxed copy of <paramref name="obj" /> if it is a value class; otherwise, <paramref name="obj" /> itself.</para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />The value type to be boxed. </param>
</Docs>
</Member>
<Member MemberName="InitializeArray">
<MemberSignature Language="ILASM" Value=".method public hidebysig static void InitializeArray(class System.Array array, valuetype System.RuntimeFieldHandle fldHandle)" />
<MemberSignature Language="C#" Value="public static void InitializeArray (Array array, RuntimeFieldHandle fldHandle);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void InitializeArray(class System.Array array, valuetype System.RuntimeFieldHandle fldHandle) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="array" Type="System.Array" />
<Parameter Name="fldHandle" Type="System.RuntimeFieldHandle" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by compilers.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a fast way to initialize an array from data that is stored in a module.</para>
</summary>
<param name="array">
<attribution license="cc4" from="Microsoft" modified="false" />The array to be initialized. </param>
<param name="fldHandle">
<attribution license="cc4" from="Microsoft" modified="false" />A field handle that specifies the location of the data used to initialize the array. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="OffsetToStringData">
<MemberSignature Language="ILASM" Value=".property int32 OffsetToStringData { public hidebysig static specialname int32 get_OffsetToStringData() }" />
<MemberSignature Language="C#" Value="public static int OffsetToStringData { get; }" />
<MemberSignature Language="ILAsm" Value=".property int32 OffsetToStringData" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>12</MemberValue>
<Docs>
<value>
<para> A <see cref="T:System.Int32" /> containing the number of bytes between the start of a <see cref="T:System.String" /> and the first <see cref="T:System.Char" />
in the string.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compilers use this property for unsafe, but efficient, pointer operations on the characters in a managed string. Compilers should pin the string against movement by the garbage collector before use. Note that common language runtime strings are immutable; that is, their contents can be read but not changed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the offset, in bytes, to the data in the given string.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="PrepareConstrainedRegions">
<MemberSignature Language="C#" Value="public static void PrepareConstrainedRegions ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void PrepareConstrainedRegions() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.WillNotCorruptState, System.Runtime.ConstrainedExecution.Cer.MayFail)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compilers use this method to mark catch, finally, and fault blocks as constrained execution regions (CERs). Code that is marked as a constrained region must only call other code with strong reliability contracts. It should not allocate or make virtual calls to unprepared or unreliable methods unless it is prepared to handle failures.</para>
<para>Note that no intermediate language opcodes, except NOP, are allowed between a call to the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareConstrainedRegions" /> method and the try block. For more information about CERs, see the classes in the <see cref="N:System.Runtime.ConstrainedExecution" /> namespace.</para>
<para>CERs that are marked using the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareConstrainedRegions" /> method do not work perfectly when a <see cref="T:System.StackOverflowException" /> is generated from the try block. For more information, see the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.ExecuteCodeWithGuaranteedCleanup(System.Runtime.CompilerServices.RuntimeHelpers.TryCode,System.Runtime.CompilerServices.RuntimeHelpers.CleanupCode,System.Object)" /> method. </para>
<para>The <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareConstrainedRegions" /> method calls the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.ProbeForSufficientStack" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Designates a body of code as a constrained execution region (CER).</para>
</summary>
</Docs>
</Member>
<Member MemberName="PrepareConstrainedRegionsNoOP">
<MemberSignature Language="C#" Value="public static void PrepareConstrainedRegionsNoOP ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void PrepareConstrainedRegionsNoOP() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.WillNotCorruptState, System.Runtime.ConstrainedExecution.Cer.MayFail)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compilers should not call this method directly. Instead, define a CER by calling the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareConstrainedRegions" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Designates a body of code as a constrained execution region (CER) without performing any probing.</para>
</summary>
</Docs>
</Member>
<Member MemberName="PrepareDelegate">
<MemberSignature Language="C#" Value="public static void PrepareDelegate (Delegate d);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void PrepareDelegate(class System.Delegate d) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="d" Type="System.Delegate" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compilers use this method to prepare a delegate's invocation method and to prepare the target of that invocation (and the delegate's statically determinable call graph) as a constrained execution region (CER).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that the specified delegate should be prepared for inclusion in a constrained execution region (CER).</para>
</summary>
<param name="d">
<attribution license="cc4" from="Microsoft" modified="false" />The delegate type to prepare.</param>
</Docs>
</Member>
<Member MemberName="PrepareMethod">
<MemberSignature Language="C#" Value="public static void PrepareMethod (RuntimeMethodHandle method);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void PrepareMethod(valuetype System.RuntimeMethodHandle method) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="method" Type="System.RuntimeMethodHandle" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Compilers use the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareMethod(System.RuntimeMethodHandle)" /> method to handle virtual calls that are made inside a constrained execution region (CER). At JIT compilation time, the common language runtime does not usually have enough information about the target of a virtual call. Therefore, the runtime does not initially prepare that segment of the call graph. If the code that is using the CER has enough knowledge to determine the target at any point in time before the CER is actually entered, it can call <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareMethod(System.RuntimeMethodHandle)" /> to perform the same runtime preparation normally done for a CER rooted at the method specified as an argument.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Prepares a method for inclusion in a constrained execution region (CER).</para>
</summary>
<param name="method">
<attribution license="cc4" from="Microsoft" modified="false" />A handle to the method to prepare.</param>
</Docs>
</Member>
<Member MemberName="PrepareMethod">
<MemberSignature Language="C#" Value="public static void PrepareMethod (RuntimeMethodHandle method, RuntimeTypeHandle[] instantiation);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void PrepareMethod(valuetype System.RuntimeMethodHandle method, valuetype System.RuntimeTypeHandle[] instantiation) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="method" Type="System.RuntimeMethodHandle" />
<Parameter Name="instantiation" Type="System.RuntimeTypeHandle[]" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can provide generics support for compilers by using the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareMethod(System.RuntimeMethodHandle,System.RuntimeTypeHandle[])" /> method. The common language runtime cannot prepare constrained execution regions (CERs) rooted in a method that has generic type parameters (either a type parameter on the class containing the method or one on the method itself) when those type parameters are instantiated as reference types.</para>
<para>You can use this overload to pass a specific instantiation (such as an array of types), specifying class type parameters first (if any), followed by method type parameters (if any). The runtime prepares that instantiation of the method. (This is necessary only if the instantiations you use contain at least one reference type parameter.) Thus, you can use a CER-style try clause in a generic method (or a nongeneric method on a generic class) and it will work reliably with instantiations of <see cref="T:System.Int32" /> or other value types. To instantiate reference types such as <see cref="T:System.String" />, you must use an explicit <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareMethod(System.RuntimeMethodHandle,System.RuntimeTypeHandle[])" /> method on the CER root method first.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Prepares a method for inclusion in a constrained execution region (CER) with the specified instantiation.</para>
</summary>
<param name="method">
<attribution license="cc4" from="Microsoft" modified="false" />A handle to the method to prepare.</param>
<param name="instantiation">
<attribution license="cc4" from="Microsoft" modified="false" />The instantiation to pass to the method.</param>
</Docs>
</Member>
<Member MemberName="ProbeForSufficientStack">
<MemberSignature Language="C#" Value="public static void ProbeForSufficientStack ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void ProbeForSufficientStack() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.ConstrainedExecution.ReliabilityContract(System.Runtime.ConstrainedExecution.Consistency.WillNotCorruptState, System.Runtime.ConstrainedExecution.Cer.MayFail)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by the constrained execution region (CER) infrastructure when running in hosts that are resilient to stack overflow such as Microsoft SQL Server and Microsoft Exchange Server. This method currently probes for 48 KB of stack space on the x86 platform, but the exact amount may change over time and may vary on other platforms.</para>
<para>This method is also used by compilers.</para>
<para>Instead of using the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.ProbeForSufficientStack" /> method, you should use a standard CER. That is, if you are planning to use a moderate amount of stack space, call the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.PrepareConstrainedRegions" /> method immediately before your try/finally or try/catch block. If you are calling a recursive method or plan to use a lot of stack space, you must use the <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.ExecuteCodeWithGuaranteedCleanup(System.Runtime.CompilerServices.RuntimeHelpers.TryCode,System.Runtime.CompilerServices.RuntimeHelpers.CleanupCode,System.Object)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Probes for a certain amount of stack space to ensure that a stack overflow cannot happen within a subsequent block of code (assuming that your code uses only a finite and moderate amount of stack space). We recommend that you use a constrained execution region (CER) instead of this method.</para>
</summary>
</Docs>
</Member>
<Member MemberName="RunClassConstructor">
<MemberSignature Language="ILASM" Value=".method public hidebysig static void RunClassConstructor(valuetype System.RuntimeTypeHandle type)" />
<MemberSignature Language="C#" Value="public static void RunClassConstructor (RuntimeTypeHandle type);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void RunClassConstructor(valuetype System.RuntimeTypeHandle type) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.RuntimeTypeHandle" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by compilers.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Runs a specified class constructor method.</para>
</summary>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />A type handle that specifies the class constructor method to run. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="RunModuleConstructor">
<MemberSignature Language="C#" Value="public static void RunModuleConstructor (IntPtr module);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="module" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="module">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RunModuleConstructor">
<MemberSignature Language="C#" Value="public static void RunModuleConstructor (ModuleHandle module);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void RunModuleConstructor(valuetype System.ModuleHandle module) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="module" Type="System.ModuleHandle" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by compilers.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Runs a specified module constructor method.</para>
</summary>
<param name="module">
<attribution license="cc4" from="Microsoft" modified="false" />A handle that specifies the module constructor method to run.</param>
</Docs>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>
|