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.Handles.xml 12 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Runtime.Handles</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Win32.SafeHandles.SafeWaitHandle">
  8. <summary>Represents a wrapper class for a wait handle. </summary>
  9. </member>
  10. <member name="M:Microsoft.Win32.SafeHandles.SafeWaitHandle.#ctor(System.IntPtr,System.Boolean)">
  11. <summary>Initializes a new instance of the <see cref="T:Microsoft.Win32.SafeHandles.SafeWaitHandle" /> class. </summary>
  12. <param name="existingHandle">An <see cref="T:System.IntPtr" /> object that represents the pre-existing handle to use.</param>
  13. <param name="ownsHandle">true to reliably release the handle during the finalization phase; false to prevent reliable release (not recommended).</param>
  14. </member>
  15. <member name="P:Microsoft.Win32.SafeHandles.SafeWaitHandle.IsInvalid"></member>
  16. <member name="T:System.IO.HandleInheritability">
  17. <summary>Specifies whether the underlying handle is inheritable by child processes.</summary>
  18. </member>
  19. <member name="F:System.IO.HandleInheritability.Inheritable">
  20. <summary>Specifies that the handle is inheritable by child processes.</summary>
  21. </member>
  22. <member name="F:System.IO.HandleInheritability.None">
  23. <summary>Specifies that the handle is not inheritable by child processes.</summary>
  24. </member>
  25. <member name="T:System.Runtime.InteropServices.CriticalHandle">
  26. <summary>Represents a wrapper class for handle resources.</summary>
  27. </member>
  28. <member name="M:System.Runtime.InteropServices.CriticalHandle.#ctor(System.IntPtr)">
  29. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.CriticalHandle" /> class with the specified invalid handle value.</summary>
  30. <param name="invalidHandleValue">The value of an invalid handle (usually 0 or -1).</param>
  31. <exception cref="T:System.TypeLoadException">The derived class resides in an assembly without unmanaged code access permission.</exception>
  32. </member>
  33. <member name="M:System.Runtime.InteropServices.CriticalHandle.Dispose">
  34. <summary>Releases all resources used by the <see cref="T:System.Runtime.InteropServices.CriticalHandle" />. </summary>
  35. <PermissionSet>
  36. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  37. </PermissionSet>
  38. </member>
  39. <member name="M:System.Runtime.InteropServices.CriticalHandle.Dispose(System.Boolean)">
  40. <summary>Releases the unmanaged resources used by the <see cref="T:System.Runtime.InteropServices.CriticalHandle" /> class specifying whether to perform a normal dispose operation.</summary>
  41. <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
  42. </member>
  43. <member name="M:System.Runtime.InteropServices.CriticalHandle.Finalize">
  44. <summary>Frees all resources associated with the handle.</summary>
  45. </member>
  46. <member name="F:System.Runtime.InteropServices.CriticalHandle.handle">
  47. <summary>Specifies the handle to be wrapped.</summary>
  48. </member>
  49. <member name="P:System.Runtime.InteropServices.CriticalHandle.IsClosed">
  50. <summary>Gets a value indicating whether the handle is closed.</summary>
  51. <returns>true if the handle is closed; otherwise, false.</returns>
  52. <PermissionSet>
  53. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  54. </PermissionSet>
  55. </member>
  56. <member name="P:System.Runtime.InteropServices.CriticalHandle.IsInvalid">
  57. <summary>When overridden in a derived class, gets a value indicating whether the handle value is invalid.</summary>
  58. <returns>true if the handle is valid; otherwise, false.</returns>
  59. <PermissionSet>
  60. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  61. </PermissionSet>
  62. </member>
  63. <member name="M:System.Runtime.InteropServices.CriticalHandle.ReleaseHandle">
  64. <summary>When overridden in a derived class, executes the code required to free the handle.</summary>
  65. <returns>true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant.</returns>
  66. </member>
  67. <member name="M:System.Runtime.InteropServices.CriticalHandle.SetHandle(System.IntPtr)">
  68. <summary>Sets the handle to the specified pre-existing handle.</summary>
  69. <param name="handle">The pre-existing handle to use.</param>
  70. </member>
  71. <member name="M:System.Runtime.InteropServices.CriticalHandle.SetHandleAsInvalid">
  72. <summary>Marks a handle as invalid.</summary>
  73. <PermissionSet>
  74. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  75. </PermissionSet>
  76. </member>
  77. <member name="T:System.Runtime.InteropServices.SafeHandle">
  78. <summary>Represents a wrapper class for operating system handles. This class must be inherited.</summary>
  79. </member>
  80. <member name="M:System.Runtime.InteropServices.SafeHandle.#ctor(System.IntPtr,System.Boolean)">
  81. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.SafeHandle" /> class with the specified invalid handle value.</summary>
  82. <param name="invalidHandleValue">The value of an invalid handle (usually 0 or -1). Your implementation of <see cref="P:System.Runtime.InteropServices.SafeHandle.IsInvalid" /> should return true for this value.</param>
  83. <param name="ownsHandle">true to reliably let <see cref="T:System.Runtime.InteropServices.SafeHandle" /> release the handle during the finalization phase; otherwise, false (not recommended). </param>
  84. <exception cref="T:System.TypeLoadException">The derived class resides in an assembly without unmanaged code access permission. </exception>
  85. </member>
  86. <member name="M:System.Runtime.InteropServices.SafeHandle.DangerousAddRef(System.Boolean@)">
  87. <summary>Manually increments the reference counter on <see cref="T:System.Runtime.InteropServices.SafeHandle" /> instances.</summary>
  88. <param name="success">true if the reference counter was successfully incremented; otherwise, false.</param>
  89. <PermissionSet>
  90. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  91. </PermissionSet>
  92. </member>
  93. <member name="M:System.Runtime.InteropServices.SafeHandle.DangerousGetHandle">
  94. <summary>Returns the value of the <see cref="F:System.Runtime.InteropServices.SafeHandle.handle" /> field.</summary>
  95. <returns>An IntPtr representing the value of the <see cref="F:System.Runtime.InteropServices.SafeHandle.handle" /> field. If the handle has been marked invalid with <see cref="M:System.Runtime.InteropServices.SafeHandle.SetHandleAsInvalid" />, this method still returns the original handle value, which can be a stale value.</returns>
  96. <PermissionSet>
  97. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  98. </PermissionSet>
  99. </member>
  100. <member name="M:System.Runtime.InteropServices.SafeHandle.DangerousRelease">
  101. <summary>Manually decrements the reference counter on a <see cref="T:System.Runtime.InteropServices.SafeHandle" /> instance.</summary>
  102. <PermissionSet>
  103. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  104. </PermissionSet>
  105. </member>
  106. <member name="M:System.Runtime.InteropServices.SafeHandle.Dispose">
  107. <summary>Releases all resources used by the <see cref="T:System.Runtime.InteropServices.SafeHandle" /> class.</summary>
  108. <PermissionSet>
  109. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  110. </PermissionSet>
  111. </member>
  112. <member name="M:System.Runtime.InteropServices.SafeHandle.Dispose(System.Boolean)">
  113. <summary>Releases the unmanaged resources used by the <see cref="T:System.Runtime.InteropServices.SafeHandle" /> class specifying whether to perform a normal dispose operation.</summary>
  114. <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
  115. </member>
  116. <member name="M:System.Runtime.InteropServices.SafeHandle.Finalize">
  117. <summary>Frees all resources associated with the handle.</summary>
  118. </member>
  119. <member name="F:System.Runtime.InteropServices.SafeHandle.handle">
  120. <summary>Specifies the handle to be wrapped.</summary>
  121. </member>
  122. <member name="P:System.Runtime.InteropServices.SafeHandle.IsClosed">
  123. <summary>Gets a value indicating whether the handle is closed.</summary>
  124. <returns>true if the handle is closed; otherwise, false.</returns>
  125. <PermissionSet>
  126. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  127. </PermissionSet>
  128. </member>
  129. <member name="P:System.Runtime.InteropServices.SafeHandle.IsInvalid">
  130. <summary>When overridden in a derived class, gets a value indicating whether the handle value is invalid.</summary>
  131. <returns>true if the handle value is invalid; otherwise, false.</returns>
  132. <PermissionSet>
  133. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  134. </PermissionSet>
  135. </member>
  136. <member name="M:System.Runtime.InteropServices.SafeHandle.ReleaseHandle">
  137. <summary>When overridden in a derived class, executes the code required to free the handle.</summary>
  138. <returns>true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant.</returns>
  139. </member>
  140. <member name="M:System.Runtime.InteropServices.SafeHandle.SetHandle(System.IntPtr)">
  141. <summary>Sets the handle to the specified pre-existing handle.</summary>
  142. <param name="handle">The pre-existing handle to use. </param>
  143. </member>
  144. <member name="M:System.Runtime.InteropServices.SafeHandle.SetHandleAsInvalid">
  145. <summary>Marks a handle as no longer used.</summary>
  146. <PermissionSet>
  147. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode" />
  148. </PermissionSet>
  149. </member>
  150. <member name="T:System.Threading.WaitHandleExtensions">
  151. <summary>Provides convenience methods to for working with a safe handle for a wait handle. </summary>
  152. </member>
  153. <member name="M:System.Threading.WaitHandleExtensions.GetSafeWaitHandle(System.Threading.WaitHandle)">
  154. <summary>Gets the safe handle for a native operating system wait handle. </summary>
  155. <returns>The safe wait handle that wraps the native operating system wait handle. </returns>
  156. <param name="waitHandle">A native operating system handle. </param>
  157. <exception cref="T:System.ArgumentNullException">
  158. <paramref name="waitHandle" /> is null. </exception>
  159. </member>
  160. <member name="M:System.Threading.WaitHandleExtensions.SetSafeWaitHandle(System.Threading.WaitHandle,Microsoft.Win32.SafeHandles.SafeWaitHandle)">
  161. <summary>Sets a safe handle for a native operating system wait handle. </summary>
  162. <param name="waitHandle">A wait handle that encapsulates an operating system-specific object that waits for exclusive access to a shared resource. </param>
  163. <param name="value">The safe handle to wrap the operating system handle. </param>
  164. <exception cref="T:System.ArgumentNullException">
  165. <paramref name="waitHandle" /> is null. </exception>
  166. </member>
  167. </members>
  168. </doc>