System.Runtime.InteropServices.WindowsRuntime.xml 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Runtime.InteropServices.WindowsRuntime</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Runtime.InteropServices.WindowsRuntime.DefaultInterfaceAttribute">
  8. <summary>Specifies the default interface of a managed Windows Runtime class.</summary>
  9. </member>
  10. <member name="M:System.Runtime.InteropServices.WindowsRuntime.DefaultInterfaceAttribute.#ctor(System.Type)">
  11. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.DefaultInterfaceAttribute" /> class. </summary>
  12. <param name="defaultInterface">The interface type that is specified as the default interface for the class the attribute is applied to. </param>
  13. </member>
  14. <member name="P:System.Runtime.InteropServices.WindowsRuntime.DefaultInterfaceAttribute.DefaultInterface">
  15. <summary>Gets the type of the default interface. </summary>
  16. <returns>The type of the default interface. </returns>
  17. </member>
  18. <member name="T:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken">
  19. <summary>A token that is returned when an event handler is added to a Windows Runtime event. The token is used to remove the event handler from the event at a later time. </summary>
  20. </member>
  21. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken.Equals(System.Object)">
  22. <summary>Returns a value that indicates whether the current object is equal to the specified object. </summary>
  23. <returns>true if the current object is equal to <paramref name="obj" />; otherwise, false.</returns>
  24. <param name="obj">The object to compare.</param>
  25. </member>
  26. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken.GetHashCode">
  27. <summary>Returns the hash code for this instance. </summary>
  28. <returns>The hash code for this instance. </returns>
  29. </member>
  30. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken.op_Equality(System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken,System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken)">
  31. <summary>Indicates whether two <see cref="T:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken" /> instances are equal. </summary>
  32. <returns>true if the two objects are equal; otherwise, false. </returns>
  33. <param name="left">The first instance to compare. </param>
  34. <param name="right">The second instance to compare. </param>
  35. </member>
  36. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken.op_Inequality(System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken,System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken)">
  37. <summary>Indicates whether two <see cref="T:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken" /> instances are not equal.</summary>
  38. <returns>true if the two instances are not equal; otherwise, false. </returns>
  39. <param name="left">The first instance to compare. </param>
  40. <param name="right">The second instance to compare. </param>
  41. </member>
  42. <member name="T:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1">
  43. <summary>Stores mappings between delegates and event tokens, to support the implementation of a Windows Runtime event in managed code.</summary>
  44. <typeparam name="T">The type of the event handler delegate for a particular event. </typeparam>
  45. </member>
  46. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.#ctor">
  47. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1" /> class. </summary>
  48. <exception cref="T:System.InvalidOperationException">
  49. <paramref name="T" /> is not a delegate type. </exception>
  50. </member>
  51. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.AddEventHandler(`0)">
  52. <summary>Adds the specified event handler to the table and to the invocation list, and returns a token that can be used to remove the event handler. </summary>
  53. <returns>A token that can be used to remove the event handler from the table and the invocation list. </returns>
  54. <param name="handler">The event handler to add. </param>
  55. </member>
  56. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.GetOrCreateEventRegistrationTokenTable(System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable{`0}@)">
  57. <summary>Returns the specified event registration token table, if it is not null; otherwise, returns a new event registration token table. </summary>
  58. <returns>The event registration token table that is specified by <paramref name="refEventTable" />, if it is not null; otherwise, a new event registration token table. </returns>
  59. <param name="refEventTable">An event registration token table, passed by reference. </param>
  60. </member>
  61. <member name="P:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.InvocationList">
  62. <summary>Gets or sets a delegate of type <paramref name="T" /> whose invocation list includes all the event handler delegates that have been added, and that have not yet been removed. Invoking this delegate invokes all the event handlers. </summary>
  63. <returns>A delegate of type <paramref name="T" /> that represents all the event handler delegates that are currently registered for an event. </returns>
  64. </member>
  65. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.RemoveEventHandler(System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken)">
  66. <summary>Removes the event handler that is associated with the specified token from the table and the invocation list. </summary>
  67. <param name="token">The token that was returned when the event handler was added. </param>
  68. </member>
  69. <member name="M:System.Runtime.InteropServices.WindowsRuntime.EventRegistrationTokenTable`1.RemoveEventHandler(`0)">
  70. <summary>Removes the specified event handler delegate from the table and the invocation list. </summary>
  71. <param name="handler">The event handler to remove. </param>
  72. </member>
  73. <member name="T:System.Runtime.InteropServices.WindowsRuntime.IActivationFactory">
  74. <summary>Enables classes to be activated by the Windows Runtime. </summary>
  75. </member>
  76. <member name="M:System.Runtime.InteropServices.WindowsRuntime.IActivationFactory.ActivateInstance">
  77. <summary>Returns a new instance of the Windows Runtime class that is created by the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.IActivationFactory" /> interface. </summary>
  78. <returns>The new instance of the Windows Runtime class. </returns>
  79. </member>
  80. <member name="T:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute">
  81. <summary>Specifies the version of the target type that first implemented the specified interface.</summary>
  82. </member>
  83. <member name="M:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute.#ctor(System.Type,System.Byte,System.Byte,System.Byte,System.Byte)">
  84. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute" /> class, specifying the interface that the target type implements and the version in which that interface was first implemented. </summary>
  85. <param name="interfaceType">The interface that was first implemented in the specified version of the target type. </param>
  86. <param name="majorVersion">The major component of the version of the target type that first implemented <paramref name="interfaceType" />.</param>
  87. <param name="minorVersion">The minor component of the version of the target type that first implemented <paramref name="interfaceType" />.</param>
  88. <param name="buildVersion">The build component of the version of the target type that first implemented <paramref name="interfaceType" />.</param>
  89. <param name="revisionVersion">The revision component of the version of the target type that first implemented <paramref name="interfaceType" />.</param>
  90. </member>
  91. <member name="P:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute.BuildVersion">
  92. <summary>Gets the build component of the version of the target type that first implemented the interface. </summary>
  93. <returns>The build component of the version.</returns>
  94. </member>
  95. <member name="P:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute.InterfaceType">
  96. <summary>Gets the type of the interface that the target type implements. </summary>
  97. <returns>The type of the interface. </returns>
  98. </member>
  99. <member name="P:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute.MajorVersion">
  100. <summary>Gets the major component of the version of the target type that first implemented the interface. </summary>
  101. <returns>The major component of the version.</returns>
  102. </member>
  103. <member name="P:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute.MinorVersion">
  104. <summary>Gets the minor component of the version of the target type that first implemented the interface. </summary>
  105. <returns>The minor component of the version. </returns>
  106. </member>
  107. <member name="P:System.Runtime.InteropServices.WindowsRuntime.InterfaceImplementedInVersionAttribute.RevisionVersion">
  108. <summary>Gets the revision component of the version of the target type that first implemented the interface. </summary>
  109. <returns>The revision component of the version.</returns>
  110. </member>
  111. <member name="T:System.Runtime.InteropServices.WindowsRuntime.ReadOnlyArrayAttribute">
  112. <summary>When applied to an array parameter in a Windows Runtime component, specifies that the contents of the array that is passed to that parameter are used only for input. The caller expects the array to be unchanged by the call. See the Remarks section for important information about callers that are written using managed code. </summary>
  113. </member>
  114. <member name="M:System.Runtime.InteropServices.WindowsRuntime.ReadOnlyArrayAttribute.#ctor">
  115. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.ReadOnlyArrayAttribute" /> class. </summary>
  116. </member>
  117. <member name="T:System.Runtime.InteropServices.WindowsRuntime.ReturnValueNameAttribute">
  118. <summary>Specifies the name of the return value of a method in a Windows Runtime component.</summary>
  119. </member>
  120. <member name="M:System.Runtime.InteropServices.WindowsRuntime.ReturnValueNameAttribute.#ctor(System.String)">
  121. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.ReturnValueNameAttribute" /> class, and specifies the name of the return value.</summary>
  122. <param name="name">The name of the return value. </param>
  123. </member>
  124. <member name="P:System.Runtime.InteropServices.WindowsRuntime.ReturnValueNameAttribute.Name">
  125. <summary>Gets the name that was specified for the return value of a method in a Windows Runtime component.</summary>
  126. <returns>The name of the method's return value. </returns>
  127. </member>
  128. <member name="T:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal">
  129. <summary>Provides helper methods for marshaling data between the .NET Framework and the Windows Runtime.</summary>
  130. </member>
  131. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.AddEventHandler``1(System.Func{``0,System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken},System.Action{System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken},``0)">
  132. <summary>Adds the specified event handler to a Windows Runtime event.</summary>
  133. <param name="addMethod">A delegate that represents the method that adds event handlers to the Windows Runtime event. </param>
  134. <param name="removeMethod">A delegate that represents the method that removes event handlers from the Windows Runtime event. </param>
  135. <param name="handler">A delegate the represents the event handler that is added. </param>
  136. <typeparam name="T">The type of the delegate that represents the event handler. </typeparam>
  137. <exception cref="T:System.ArgumentNullException">
  138. <paramref name="addMethod" /> is null. -or-<paramref name="removeMethod" /> is null.</exception>
  139. </member>
  140. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.FreeHString(System.IntPtr)">
  141. <summary>Frees the specified Windows Runtime HSTRING. </summary>
  142. <param name="ptr">The address of the HSTRING to free.</param>
  143. <exception cref="T:System.PlatformNotSupportedException">The Windows Runtime is not supported on the current version of the operating system. </exception>
  144. </member>
  145. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.GetActivationFactory(System.Type)">
  146. <summary>Returns an object that implements the activation factory interface for the specified Windows Runtime type. </summary>
  147. <returns>An object that implements the activation factory interface. </returns>
  148. <param name="type">The Windows Runtime type to get the activation factory interface for. </param>
  149. <exception cref="T:System.ArgumentException">
  150. <paramref name="type" /> does not represent a Windows Runtime type (that is, belonging to the Windows Runtime itself or defined in a Windows Runtime component). -or-The object specified for <paramref name="type" /> was not provided by the common language runtime type system. </exception>
  151. <exception cref="T:System.ArgumentNullException">
  152. <paramref name="type" /> is null. </exception>
  153. <exception cref="T:System.TypeLoadException">The specified Windows Runtime class is not properly registered. For example, the .winmd file was located, but the Windows Runtime failed to locate the implementation. </exception>
  154. </member>
  155. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.PtrToStringHString(System.IntPtr)">
  156. <summary>Returns a managed string that contains a copy of the specified Windows Runtime HSTRING. </summary>
  157. <returns>A managed string that contains a copy of the HSTRING if <paramref name="ptr" /> is not <see cref="F:System.IntPtr.Zero" />; otherwise, <see cref="F:System.String.Empty" />. </returns>
  158. <param name="ptr">An unmanaged pointer to the HSTRING to copy. </param>
  159. <exception cref="T:System.PlatformNotSupportedException">The Windows Runtime is not supported on the current version of the operating system. </exception>
  160. </member>
  161. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.RemoveAllEventHandlers(System.Action{System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken})">
  162. <summary>Removes all the event handlers that can be removed by using the specified method. </summary>
  163. <param name="removeMethod">A delegate that represents the method that removes event handlers from the Windows Runtime event. </param>
  164. <exception cref="T:System.ArgumentNullException">
  165. <paramref name="removeMethod" /> is null. </exception>
  166. </member>
  167. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.RemoveEventHandler``1(System.Action{System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken},``0)">
  168. <summary>Removes the specified event handler from a Windows Runtime event. </summary>
  169. <param name="removeMethod">A delegate that represents the method that removes event handlers from the Windows Runtime event. </param>
  170. <param name="handler">The event handler that is removed. </param>
  171. <typeparam name="T">The type of the delegate that represents the event handler. </typeparam>
  172. <exception cref="T:System.ArgumentNullException">
  173. <paramref name="removeMethod" /> is null. </exception>
  174. </member>
  175. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.StringToHString(System.String)">
  176. <summary>Allocates a Windows Runtime HSTRING and copies the specified managed string to it. </summary>
  177. <returns>An unmanaged pointer to the new HSTRING, or <see cref="F:System.IntPtr.Zero" /> if <paramref name="s" /> is <see cref="F:System.String.Empty" />. </returns>
  178. <param name="s">The managed string to copy. </param>
  179. <exception cref="T:System.PlatformNotSupportedException">The Windows Runtime is not supported on the current version of the operating system. </exception>
  180. <exception cref="T:System.ArgumentNullException">
  181. <paramref name="s" /> is null. </exception>
  182. </member>
  183. <member name="T:System.Runtime.InteropServices.WindowsRuntime.WriteOnlyArrayAttribute">
  184. <summary>When applied to an array parameter in a Windows Runtime component, specifies that the contents of an array that is passed to that parameter are used only for output. The caller does not guarantee that the contents are initialized, and the called method should not read the contents. See the Remarks section for important information about callers that are written using managed code.</summary>
  185. </member>
  186. <member name="M:System.Runtime.InteropServices.WindowsRuntime.WriteOnlyArrayAttribute.#ctor">
  187. <summary>Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.WindowsRuntime.WriteOnlyArrayAttribute" /> class. </summary>
  188. </member>
  189. </members>
  190. </doc>