mcs/class/corlib/Documentation/en/System.Runtime.InteropServices.WindowsRuntime/WindowsRuntimeMarshal.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="WindowsRuntimeMarshal" FullName="System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal">
   3   <TypeSignature Language="C#" Value="public static class WindowsRuntimeMarshal" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit WindowsRuntimeMarshal extends System.Object" />
   5   <AssemblyInfo>
   6     <AssemblyName>mscorlib</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Object</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Docs>
  14     <remarks>To be added.</remarks>
  15     <summary>
  16       <attribution license="cc4" from="Microsoft" modified="false" />
  17       <para>Provides helper methods for marshaling data between the .NET Framework and the wrt.</para>
  18     </summary>
  19   </Docs>
  20   <Members>
  21     <Member MemberName="AddEventHandler&lt;T&gt;">
  22       <MemberSignature Language="C#" Value="public static void AddEventHandler&lt;T&gt; (Func&lt;T,System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; addMethod, Action&lt;System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; removeMethod, T handler);" />
  23       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddEventHandler&lt;T&gt;(class System.Func`2&lt;!!T, valuetype System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; addMethod, class System.Action`1&lt;valuetype System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; removeMethod, !!T handler) cil managed" />
  24       <MemberType>Method</MemberType>
  25       <AssemblyInfo>
  26         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  27       </AssemblyInfo>
  28       <ReturnValue>
  29         <ReturnType>System.Void</ReturnType>
  30       </ReturnValue>
  31       <TypeParameters>
  32         <TypeParameter Name="T" />
  33       </TypeParameters>
  34       <Parameters>
  35         <Parameter Name="addMethod" Type="System.Func&lt;T,System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt;" />
  36         <Parameter Name="removeMethod" Type="System.Action&lt;System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt;" />
  37         <Parameter Name="handler" Type="T" />
  38       </Parameters>
  39       <Docs>
  40         <typeparam name="T">To be added.</typeparam>
  41         <param name="addMethod">To be added.</param>
  42         <param name="removeMethod">To be added.</param>
  43         <param name="handler">To be added.</param>
  44         <summary>To be added.</summary>
  45         <remarks>To be added.</remarks>
  46       </Docs>
  47     </Member>
  48     <Member MemberName="FreeHString">
  49       <MemberSignature Language="C#" Value="public static void FreeHString (IntPtr ptr);" />
  50       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void FreeHString(native int ptr) cil managed" />
  51       <MemberType>Method</MemberType>
  52       <AssemblyInfo>
  53         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  54       </AssemblyInfo>
  55       <ReturnValue>
  56         <ReturnType>System.Void</ReturnType>
  57       </ReturnValue>
  58       <Parameters>
  59         <Parameter Name="ptr" Type="System.IntPtr" />
  60       </Parameters>
  61       <Docs>
  62         <remarks>To be added.</remarks>
  63         <summary>
  64           <attribution license="cc4" from="Microsoft" modified="false" />
  65           <para>Frees the specified wrt <see cref="http://go.microsoft.com/fwlink/p/?LinkId=246451">HSTRING</see>. </para>
  66         </summary>
  67         <param name="ptr">
  68           <attribution license="cc4" from="Microsoft" modified="false" />The address of the <see cref="http://go.microsoft.com/fwlink/p/?LinkId=246451">HSTRING</see> to free.</param>
  69       </Docs>
  70     </Member>
  71     <Member MemberName="GetActivationFactory">
  72       <MemberSignature Language="C#" Value="public static System.Runtime.InteropServices.WindowsRuntime.IActivationFactory GetActivationFactory (Type type);" />
  73       <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Runtime.InteropServices.WindowsRuntime.IActivationFactory GetActivationFactory(class System.Type type) cil managed" />
  74       <MemberType>Method</MemberType>
  75       <AssemblyInfo>
  76         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  77       </AssemblyInfo>
  78       <ReturnValue>
  79         <ReturnType>System.Runtime.InteropServices.WindowsRuntime.IActivationFactory</ReturnType>
  80       </ReturnValue>
  81       <Parameters>
  82         <Parameter Name="type" Type="System.Type" />
  83       </Parameters>
  84       <Docs>
  85         <returns>To be added.</returns>
  86         <remarks>
  87           <attribution license="cc4" from="Microsoft" modified="false" />
  88           <para>In addition to the exceptions in the Exceptions section, any <unmanagedCodeEntityReference>HRESULT</unmanagedCodeEntityReference> other than <unmanagedCodeEntityReference>S_OK</unmanagedCodeEntityReference> that is returned by the underlying factory method will be marshaled as an exception. </para>
  89         </remarks>
  90         <summary>
  91           <attribution license="cc4" from="Microsoft" modified="false" />
  92           <para>Returns an object that implements the activation factory interface for the specified wrt type. </para>
  93         </summary>
  94         <param name="type">
  95           <attribution license="cc4" from="Microsoft" modified="false" />The wrt type to get the activation factory interface for. </param>
  96       </Docs>
  97     </Member>
  98     <Member MemberName="PtrToStringHString">
  99       <MemberSignature Language="C#" Value="public static string PtrToStringHString (IntPtr ptr);" />
 100       <MemberSignature Language="ILAsm" Value=".method public static hidebysig string PtrToStringHString(native int ptr) cil managed" />
 101       <MemberType>Method</MemberType>
 102       <AssemblyInfo>
 103         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105       <ReturnValue>
 106         <ReturnType>System.String</ReturnType>
 107       </ReturnValue>
 108       <Parameters>
 109         <Parameter Name="ptr" Type="System.IntPtr" />
 110       </Parameters>
 111       <Docs>
 112         <returns>To be added.</returns>
 113         <remarks>To be added.</remarks>
 114         <summary>
 115           <attribution license="cc4" from="Microsoft" modified="false" />
 116           <para>Returns a managed string that contains a copy of the specified wrt <see cref="http://go.microsoft.com/fwlink/p/?LinkId=246451">HSTRING</see>. </para>
 117         </summary>
 118         <param name="ptr">
 119           <attribution license="cc4" from="Microsoft" modified="false" />An unmanaged pointer to the <see cref="http://go.microsoft.com/fwlink/p/?LinkId=246451">HSTRING</see> to copy. </param>
 120       </Docs>
 121     </Member>
 122     <Member MemberName="RemoveAllEventHandlers">
 123       <MemberSignature Language="C#" Value="public static void RemoveAllEventHandlers (Action&lt;System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; removeMethod);" />
 124       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RemoveAllEventHandlers(class System.Action`1&lt;valuetype System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; removeMethod) cil managed" />
 125       <MemberType>Method</MemberType>
 126       <AssemblyInfo>
 127         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 128       </AssemblyInfo>
 129       <ReturnValue>
 130         <ReturnType>System.Void</ReturnType>
 131       </ReturnValue>
 132       <Parameters>
 133         <Parameter Name="removeMethod" Type="System.Action&lt;System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt;" />
 134       </Parameters>
 135       <Docs>
 136         <param name="removeMethod">To be added.</param>
 137         <summary>To be added.</summary>
 138         <remarks>To be added.</remarks>
 139       </Docs>
 140     </Member>
 141     <Member MemberName="RemoveEventHandler&lt;T&gt;">
 142       <MemberSignature Language="C#" Value="public static void RemoveEventHandler&lt;T&gt; (Action&lt;System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; removeMethod, T handler);" />
 143       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RemoveEventHandler&lt;T&gt;(class System.Action`1&lt;valuetype System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt; removeMethod, !!T handler) cil managed" />
 144       <MemberType>Method</MemberType>
 145       <AssemblyInfo>
 146         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 147       </AssemblyInfo>
 148       <ReturnValue>
 149         <ReturnType>System.Void</ReturnType>
 150       </ReturnValue>
 151       <TypeParameters>
 152         <TypeParameter Name="T" />
 153       </TypeParameters>
 154       <Parameters>
 155         <Parameter Name="removeMethod" Type="System.Action&lt;System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken&gt;" />
 156         <Parameter Name="handler" Type="T" />
 157       </Parameters>
 158       <Docs>
 159         <typeparam name="T">To be added.</typeparam>
 160         <param name="removeMethod">To be added.</param>
 161         <param name="handler">To be added.</param>
 162         <summary>To be added.</summary>
 163         <remarks>To be added.</remarks>
 164       </Docs>
 165     </Member>
 166     <Member MemberName="StringToHString">
 167       <MemberSignature Language="C#" Value="public static IntPtr StringToHString (string s);" />
 168       <MemberSignature Language="ILAsm" Value=".method public static hidebysig native int StringToHString(string s) cil managed" />
 169       <MemberType>Method</MemberType>
 170       <AssemblyInfo>
 171         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 172       </AssemblyInfo>
 173       <ReturnValue>
 174         <ReturnType>System.IntPtr</ReturnType>
 175       </ReturnValue>
 176       <Parameters>
 177         <Parameter Name="s" Type="System.String" />
 178       </Parameters>
 179       <Docs>
 180         <returns>To be added.</returns>
 181         <remarks>
 182           <attribution license="cc4" from="Microsoft" modified="false" />
 183           <para>Use the <see cref="M:System.Runtime.InteropServices.WindowsRuntime.WindowsRuntimeMarshal.FreeHString(System.IntPtr)" /> method to release the <see cref="http://go.microsoft.com/fwlink/p/?LinkId=246451">HSTRING</see> when you are done using it. </para>
 184         </remarks>
 185         <summary>
 186           <attribution license="cc4" from="Microsoft" modified="false" />
 187           <para>Allocates a wrt <see cref="http://go.microsoft.com/fwlink/p/?LinkId=246451">HSTRING</see> and copies the specified managed string to it. </para>
 188         </summary>
 189         <param name="s">
 190           <attribution license="cc4" from="Microsoft" modified="false" />The managed string to copy. </param>
 191       </Docs>
 192     </Member>
 193   </Members>
 194 </Type>