mcs/class/corlib/Documentation/en/System.Runtime.InteropServices.ComTypes/IMoniker.xml

   1 <Type Name="IMoniker" FullName="System.Runtime.InteropServices.ComTypes.IMoniker">
   2   <TypeSignature Language="C#" Value="public interface IMoniker" />
   3   <AssemblyInfo>
   4     <AssemblyName>mscorlib</AssemblyName>
   5     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   6   </AssemblyInfo>
   7   <Interfaces />
   8   <Attributes>
   9     <Attribute>
  10       <AttributeName>System.Runtime.InteropServices.Guid("0000000f-0000-0000-c000-000000000046")</AttributeName>
  11     </Attribute>
  12     <Attribute>
  13       <AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)</AttributeName>
  14     </Attribute>
  15   </Attributes>
  16   <Docs>
  17     <summary>To be added.</summary>
  18     <remarks>To be added.</remarks>
  19     <since version=".NET 2.0" />
  20   </Docs>
  21   <Members>
  22     <Member MemberName="BindToObject">
  23       <MemberSignature Language="C#" Value="public void BindToObject (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, System.Runtime.InteropServices.ComTypes.IMoniker pmkToLeft, ref Guid riidResult, out object ppvResult);" />
  24       <MemberType>Method</MemberType>
  25       <ReturnValue>
  26         <ReturnType>System.Void</ReturnType>
  27       </ReturnValue>
  28       <Parameters>
  29         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
  30         <Parameter Name="pmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
  31         <Parameter Name="riidResult" Type="System.Guid&amp;" RefType="ref" />
  32         <Parameter Name="ppvResult" Type="System.Object&amp;" RefType="out" />
  33       </Parameters>
  34       <Docs>
  35         <param name="pbc">To be added.</param>
  36         <param name="pmkToLeft">To be added.</param>
  37         <param name="riidResult">To be added.</param>
  38         <param name="ppvResult">To be added.</param>
  39         <summary>To be added.</summary>
  40         <remarks>To be added.</remarks>
  41         <since version=".NET 2.0" />
  42       </Docs>
  43       <AssemblyInfo>
  44         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  45       </AssemblyInfo>
  46     </Member>
  47     <Member MemberName="BindToStorage">
  48       <MemberSignature Language="C#" Value="public void BindToStorage (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, System.Runtime.InteropServices.ComTypes.IMoniker pmkToLeft, ref Guid riid, out object ppvObj);" />
  49       <MemberType>Method</MemberType>
  50       <ReturnValue>
  51         <ReturnType>System.Void</ReturnType>
  52       </ReturnValue>
  53       <Parameters>
  54         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
  55         <Parameter Name="pmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
  56         <Parameter Name="riid" Type="System.Guid&amp;" RefType="ref" />
  57         <Parameter Name="ppvObj" Type="System.Object&amp;" RefType="out" />
  58       </Parameters>
  59       <Docs>
  60         <param name="pbc">To be added.</param>
  61         <param name="pmkToLeft">To be added.</param>
  62         <param name="riid">To be added.</param>
  63         <param name="ppvObj">To be added.</param>
  64         <summary>To be added.</summary>
  65         <remarks>To be added.</remarks>
  66         <since version=".NET 2.0" />
  67       </Docs>
  68       <AssemblyInfo>
  69         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  70       </AssemblyInfo>
  71     </Member>
  72     <Member MemberName="CommonPrefixWith">
  73       <MemberSignature Language="C#" Value="public void CommonPrefixWith (System.Runtime.InteropServices.ComTypes.IMoniker pmkOther, out System.Runtime.InteropServices.ComTypes.IMoniker ppmkPrefix);" />
  74       <MemberType>Method</MemberType>
  75       <ReturnValue>
  76         <ReturnType>System.Void</ReturnType>
  77       </ReturnValue>
  78       <Parameters>
  79         <Parameter Name="pmkOther" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
  80         <Parameter Name="ppmkPrefix" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="out" />
  81       </Parameters>
  82       <Docs>
  83         <param name="pmkOther">To be added.</param>
  84         <param name="ppmkPrefix">To be added.</param>
  85         <summary>To be added.</summary>
  86         <remarks>To be added.</remarks>
  87         <since version=".NET 2.0" />
  88       </Docs>
  89       <AssemblyInfo>
  90         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  91       </AssemblyInfo>
  92     </Member>
  93     <Member MemberName="ComposeWith">
  94       <MemberSignature Language="C#" Value="public void ComposeWith (System.Runtime.InteropServices.ComTypes.IMoniker pmkRight, bool fOnlyIfNotGeneric, out System.Runtime.InteropServices.ComTypes.IMoniker ppmkComposite);" />
  95       <MemberType>Method</MemberType>
  96       <ReturnValue>
  97         <ReturnType>System.Void</ReturnType>
  98       </ReturnValue>
  99       <Parameters>
 100         <Parameter Name="pmkRight" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 101         <Parameter Name="fOnlyIfNotGeneric" Type="System.Boolean" />
 102         <Parameter Name="ppmkComposite" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="out" />
 103       </Parameters>
 104       <Docs>
 105         <param name="pmkRight">To be added.</param>
 106         <param name="fOnlyIfNotGeneric">To be added.</param>
 107         <param name="ppmkComposite">To be added.</param>
 108         <summary>To be added.</summary>
 109         <remarks>To be added.</remarks>
 110         <since version=".NET 2.0" />
 111       </Docs>
 112       <AssemblyInfo>
 113         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 114       </AssemblyInfo>
 115     </Member>
 116     <Member MemberName="Enum">
 117       <MemberSignature Language="C#" Value="public void Enum (bool fForward, out System.Runtime.InteropServices.ComTypes.IEnumMoniker ppenumMoniker);" />
 118       <MemberType>Method</MemberType>
 119       <ReturnValue>
 120         <ReturnType>System.Void</ReturnType>
 121       </ReturnValue>
 122       <Parameters>
 123         <Parameter Name="fForward" Type="System.Boolean" />
 124         <Parameter Name="ppenumMoniker" Type="System.Runtime.InteropServices.ComTypes.IEnumMoniker&amp;" RefType="out" />
 125       </Parameters>
 126       <Docs>
 127         <param name="fForward">To be added.</param>
 128         <param name="ppenumMoniker">To be added.</param>
 129         <summary>To be added.</summary>
 130         <remarks>To be added.</remarks>
 131         <since version=".NET 2.0" />
 132       </Docs>
 133       <AssemblyInfo>
 134         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 135       </AssemblyInfo>
 136     </Member>
 137     <Member MemberName="GetClassID">
 138       <MemberSignature Language="C#" Value="public void GetClassID (out Guid pClassID);" />
 139       <MemberType>Method</MemberType>
 140       <ReturnValue>
 141         <ReturnType>System.Void</ReturnType>
 142       </ReturnValue>
 143       <Parameters>
 144         <Parameter Name="pClassID" Type="System.Guid&amp;" RefType="out" />
 145       </Parameters>
 146       <Docs>
 147         <param name="pClassID">To be added.</param>
 148         <summary>To be added.</summary>
 149         <remarks>To be added.</remarks>
 150         <since version=".NET 2.0" />
 151       </Docs>
 152       <AssemblyInfo>
 153         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 154       </AssemblyInfo>
 155     </Member>
 156     <Member MemberName="GetDisplayName">
 157       <MemberSignature Language="C#" Value="public void GetDisplayName (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, System.Runtime.InteropServices.ComTypes.IMoniker pmkToLeft, out string ppszDisplayName);" />
 158       <MemberType>Method</MemberType>
 159       <ReturnValue>
 160         <ReturnType>System.Void</ReturnType>
 161       </ReturnValue>
 162       <Parameters>
 163         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
 164         <Parameter Name="pmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 165         <Parameter Name="ppszDisplayName" Type="System.String&amp;" RefType="out" />
 166       </Parameters>
 167       <Docs>
 168         <param name="pbc">To be added.</param>
 169         <param name="pmkToLeft">To be added.</param>
 170         <param name="ppszDisplayName">To be added.</param>
 171         <summary>To be added.</summary>
 172         <remarks>To be added.</remarks>
 173         <since version=".NET 2.0" />
 174       </Docs>
 175       <AssemblyInfo>
 176         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 177       </AssemblyInfo>
 178     </Member>
 179     <Member MemberName="GetSizeMax">
 180       <MemberSignature Language="C#" Value="public void GetSizeMax (out long pcbSize);" />
 181       <MemberType>Method</MemberType>
 182       <ReturnValue>
 183         <ReturnType>System.Void</ReturnType>
 184       </ReturnValue>
 185       <Parameters>
 186         <Parameter Name="pcbSize" Type="System.Int64&amp;" RefType="out" />
 187       </Parameters>
 188       <Docs>
 189         <param name="pcbSize">To be added.</param>
 190         <summary>To be added.</summary>
 191         <remarks>To be added.</remarks>
 192         <since version=".NET 2.0" />
 193       </Docs>
 194       <AssemblyInfo>
 195         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 196       </AssemblyInfo>
 197     </Member>
 198     <Member MemberName="GetTimeOfLastChange">
 199       <MemberSignature Language="C#" Value="public void GetTimeOfLastChange (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, System.Runtime.InteropServices.ComTypes.IMoniker pmkToLeft, out System.Runtime.InteropServices.ComTypes.FILETIME pFileTime);" />
 200       <MemberType>Method</MemberType>
 201       <ReturnValue>
 202         <ReturnType>System.Void</ReturnType>
 203       </ReturnValue>
 204       <Parameters>
 205         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
 206         <Parameter Name="pmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 207         <Parameter Name="pFileTime" Type="System.Runtime.InteropServices.ComTypes.FILETIME&amp;" RefType="out" />
 208       </Parameters>
 209       <Docs>
 210         <param name="pbc">To be added.</param>
 211         <param name="pmkToLeft">To be added.</param>
 212         <param name="pFileTime">To be added.</param>
 213         <summary>To be added.</summary>
 214         <remarks>To be added.</remarks>
 215         <since version=".NET 2.0" />
 216       </Docs>
 217       <AssemblyInfo>
 218         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 219       </AssemblyInfo>
 220     </Member>
 221     <Member MemberName="Hash">
 222       <MemberSignature Language="C#" Value="public void Hash (out int pdwHash);" />
 223       <MemberType>Method</MemberType>
 224       <ReturnValue>
 225         <ReturnType>System.Void</ReturnType>
 226       </ReturnValue>
 227       <Parameters>
 228         <Parameter Name="pdwHash" Type="System.Int32&amp;" RefType="out" />
 229       </Parameters>
 230       <Docs>
 231         <param name="pdwHash">To be added.</param>
 232         <summary>To be added.</summary>
 233         <remarks>To be added.</remarks>
 234         <since version=".NET 2.0" />
 235       </Docs>
 236       <AssemblyInfo>
 237         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 238       </AssemblyInfo>
 239     </Member>
 240     <Member MemberName="Inverse">
 241       <MemberSignature Language="C#" Value="public void Inverse (out System.Runtime.InteropServices.ComTypes.IMoniker ppmk);" />
 242       <MemberType>Method</MemberType>
 243       <ReturnValue>
 244         <ReturnType>System.Void</ReturnType>
 245       </ReturnValue>
 246       <Parameters>
 247         <Parameter Name="ppmk" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="out" />
 248       </Parameters>
 249       <Docs>
 250         <param name="ppmk">To be added.</param>
 251         <summary>To be added.</summary>
 252         <remarks>To be added.</remarks>
 253         <since version=".NET 2.0" />
 254       </Docs>
 255       <AssemblyInfo>
 256         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 257       </AssemblyInfo>
 258     </Member>
 259     <Member MemberName="IsDirty">
 260       <MemberSignature Language="C#" Value="public int IsDirty ();" />
 261       <MemberType>Method</MemberType>
 262       <ReturnValue>
 263         <ReturnType>System.Int32</ReturnType>
 264       </ReturnValue>
 265       <Parameters />
 266       <Docs>
 267         <summary>To be added.</summary>
 268         <returns>To be added.</returns>
 269         <remarks>To be added.</remarks>
 270         <since version=".NET 2.0" />
 271       </Docs>
 272       <AssemblyInfo>
 273         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 274       </AssemblyInfo>
 275     </Member>
 276     <Member MemberName="IsEqual">
 277       <MemberSignature Language="C#" Value="public int IsEqual (System.Runtime.InteropServices.ComTypes.IMoniker pmkOtherMoniker);" />
 278       <MemberType>Method</MemberType>
 279       <ReturnValue>
 280         <ReturnType>System.Int32</ReturnType>
 281       </ReturnValue>
 282       <Parameters>
 283         <Parameter Name="pmkOtherMoniker" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 284       </Parameters>
 285       <Docs>
 286         <param name="pmkOtherMoniker">To be added.</param>
 287         <summary>To be added.</summary>
 288         <returns>To be added.</returns>
 289         <remarks>To be added.</remarks>
 290         <since version=".NET 2.0" />
 291       </Docs>
 292       <AssemblyInfo>
 293         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 294       </AssemblyInfo>
 295     </Member>
 296     <Member MemberName="IsRunning">
 297       <MemberSignature Language="C#" Value="public int IsRunning (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, System.Runtime.InteropServices.ComTypes.IMoniker pmkToLeft, System.Runtime.InteropServices.ComTypes.IMoniker pmkNewlyRunning);" />
 298       <MemberType>Method</MemberType>
 299       <ReturnValue>
 300         <ReturnType>System.Int32</ReturnType>
 301       </ReturnValue>
 302       <Parameters>
 303         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
 304         <Parameter Name="pmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 305         <Parameter Name="pmkNewlyRunning" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 306       </Parameters>
 307       <Docs>
 308         <param name="pbc">To be added.</param>
 309         <param name="pmkToLeft">To be added.</param>
 310         <param name="pmkNewlyRunning">To be added.</param>
 311         <summary>To be added.</summary>
 312         <returns>To be added.</returns>
 313         <remarks>To be added.</remarks>
 314         <since version=".NET 2.0" />
 315       </Docs>
 316       <AssemblyInfo>
 317         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 318       </AssemblyInfo>
 319     </Member>
 320     <Member MemberName="IsSystemMoniker">
 321       <MemberSignature Language="C#" Value="public int IsSystemMoniker (out int pdwMksys);" />
 322       <MemberType>Method</MemberType>
 323       <ReturnValue>
 324         <ReturnType>System.Int32</ReturnType>
 325       </ReturnValue>
 326       <Parameters>
 327         <Parameter Name="pdwMksys" Type="System.Int32&amp;" RefType="out" />
 328       </Parameters>
 329       <Docs>
 330         <param name="pdwMksys">To be added.</param>
 331         <summary>To be added.</summary>
 332         <returns>To be added.</returns>
 333         <remarks>To be added.</remarks>
 334         <since version=".NET 2.0" />
 335       </Docs>
 336       <AssemblyInfo>
 337         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 338       </AssemblyInfo>
 339     </Member>
 340     <Member MemberName="Load">
 341       <MemberSignature Language="C#" Value="public void Load (System.Runtime.InteropServices.ComTypes.IStream pStm);" />
 342       <MemberType>Method</MemberType>
 343       <ReturnValue>
 344         <ReturnType>System.Void</ReturnType>
 345       </ReturnValue>
 346       <Parameters>
 347         <Parameter Name="pStm" Type="System.Runtime.InteropServices.ComTypes.IStream" />
 348       </Parameters>
 349       <Docs>
 350         <param name="pStm">To be added.</param>
 351         <summary>To be added.</summary>
 352         <remarks>To be added.</remarks>
 353         <since version=".NET 2.0" />
 354       </Docs>
 355       <AssemblyInfo>
 356         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 357       </AssemblyInfo>
 358     </Member>
 359     <Member MemberName="ParseDisplayName">
 360       <MemberSignature Language="C#" Value="public void ParseDisplayName (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, System.Runtime.InteropServices.ComTypes.IMoniker pmkToLeft, string pszDisplayName, out int pchEaten, out System.Runtime.InteropServices.ComTypes.IMoniker ppmkOut);" />
 361       <MemberType>Method</MemberType>
 362       <ReturnValue>
 363         <ReturnType>System.Void</ReturnType>
 364       </ReturnValue>
 365       <Parameters>
 366         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
 367         <Parameter Name="pmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 368         <Parameter Name="pszDisplayName" Type="System.String" />
 369         <Parameter Name="pchEaten" Type="System.Int32&amp;" RefType="out" />
 370         <Parameter Name="ppmkOut" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="out" />
 371       </Parameters>
 372       <Docs>
 373         <param name="pbc">To be added.</param>
 374         <param name="pmkToLeft">To be added.</param>
 375         <param name="pszDisplayName">To be added.</param>
 376         <param name="pchEaten">To be added.</param>
 377         <param name="ppmkOut">To be added.</param>
 378         <summary>To be added.</summary>
 379         <remarks>To be added.</remarks>
 380         <since version=".NET 2.0" />
 381       </Docs>
 382       <AssemblyInfo>
 383         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 384       </AssemblyInfo>
 385     </Member>
 386     <Member MemberName="Reduce">
 387       <MemberSignature Language="C#" Value="public void Reduce (System.Runtime.InteropServices.ComTypes.IBindCtx pbc, int dwReduceHowFar, ref System.Runtime.InteropServices.ComTypes.IMoniker ppmkToLeft, out System.Runtime.InteropServices.ComTypes.IMoniker ppmkReduced);" />
 388       <MemberType>Method</MemberType>
 389       <ReturnValue>
 390         <ReturnType>System.Void</ReturnType>
 391       </ReturnValue>
 392       <Parameters>
 393         <Parameter Name="pbc" Type="System.Runtime.InteropServices.ComTypes.IBindCtx" />
 394         <Parameter Name="dwReduceHowFar" Type="System.Int32" />
 395         <Parameter Name="ppmkToLeft" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="ref" />
 396         <Parameter Name="ppmkReduced" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="out" />
 397       </Parameters>
 398       <Docs>
 399         <param name="pbc">To be added.</param>
 400         <param name="dwReduceHowFar">To be added.</param>
 401         <param name="ppmkToLeft">To be added.</param>
 402         <param name="ppmkReduced">To be added.</param>
 403         <summary>To be added.</summary>
 404         <remarks>To be added.</remarks>
 405         <since version=".NET 2.0" />
 406       </Docs>
 407       <AssemblyInfo>
 408         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 409       </AssemblyInfo>
 410     </Member>
 411     <Member MemberName="RelativePathTo">
 412       <MemberSignature Language="C#" Value="public void RelativePathTo (System.Runtime.InteropServices.ComTypes.IMoniker pmkOther, out System.Runtime.InteropServices.ComTypes.IMoniker ppmkRelPath);" />
 413       <MemberType>Method</MemberType>
 414       <ReturnValue>
 415         <ReturnType>System.Void</ReturnType>
 416       </ReturnValue>
 417       <Parameters>
 418         <Parameter Name="pmkOther" Type="System.Runtime.InteropServices.ComTypes.IMoniker" />
 419         <Parameter Name="ppmkRelPath" Type="System.Runtime.InteropServices.ComTypes.IMoniker&amp;" RefType="out" />
 420       </Parameters>
 421       <Docs>
 422         <param name="pmkOther">To be added.</param>
 423         <param name="ppmkRelPath">To be added.</param>
 424         <summary>To be added.</summary>
 425         <remarks>To be added.</remarks>
 426         <since version=".NET 2.0" />
 427       </Docs>
 428       <AssemblyInfo>
 429         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 430       </AssemblyInfo>
 431     </Member>
 432     <Member MemberName="Save">
 433       <MemberSignature Language="C#" Value="public void Save (System.Runtime.InteropServices.ComTypes.IStream pStm, bool fClearDirty);" />
 434       <MemberType>Method</MemberType>
 435       <ReturnValue>
 436         <ReturnType>System.Void</ReturnType>
 437       </ReturnValue>
 438       <Parameters>
 439         <Parameter Name="pStm" Type="System.Runtime.InteropServices.ComTypes.IStream" />
 440         <Parameter Name="fClearDirty" Type="System.Boolean" />
 441       </Parameters>
 442       <Docs>
 443         <param name="pStm">To be added.</param>
 444         <param name="fClearDirty">To be added.</param>
 445         <summary>To be added.</summary>
 446         <remarks>To be added.</remarks>
 447         <since version=".NET 2.0" />
 448       </Docs>
 449       <AssemblyInfo>
 450         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 451       </AssemblyInfo>
 452     </Member>
 453   </Members>
 454 </Type>