Merge pull request #5668 from kumpera/wasm-work-p4
[mono.git] / mcs / class / corlib / Documentation / en / System.Diagnostics.SymbolStore / ISymbolDocumentWriter.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <Type Name="ISymbolDocumentWriter" FullName="System.Diagnostics.SymbolStore.ISymbolDocumentWriter">
3   <TypeSignature Maintainer="auto" Language="C#" Value="public interface ISymbolDocumentWriter" />
4   <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ISymbolDocumentWriter" />
5   <AssemblyInfo>
6     <AssemblyName>mscorlib</AssemblyName>
7     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
10     <AssemblyVersion>4.0.0.0</AssemblyVersion>
11   </AssemblyInfo>
12   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
13   <Interfaces />
14   <Attributes>
15     <Attribute>
16       <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
17     </Attribute>
18   </Attributes>
19   <Docs>
20     <remarks>
21       <attribution license="cc4" from="Microsoft" modified="false" />
22       <para>A document is defined by a URL and a document type GUID. Optionally, the document source can be stored in the symbol store.</para>
23       <block subset="none" type="note">
24         <para>This interface is the managed counterpart of the <unmanagedCodeEntityReference>ISymUnmanagedDocumentWriter</unmanagedCodeEntityReference> interface, which is one of the unmanaged symbol store interfaces that provide an alternate way to read and write debug symbol information.</para>
25       </block>
26     </remarks>
27     <summary>
28       <attribution license="cc4" from="Microsoft" modified="false" />
29       <para>Represents a document referenced by a symbol store.</para>
30     </summary>
31   </Docs>
32   <Members>
33     <Member MemberName="SetCheckSum">
34       <MemberSignature Language="C#" Value="public void SetCheckSum (Guid algorithmId, byte[] checkSum);" />
35       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetCheckSum(valuetype System.Guid algorithmId, unsigned int8[] checkSum) cil managed" />
36       <MemberType>Method</MemberType>
37       <AssemblyInfo>
38         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
39         <AssemblyVersion>2.0.0.0</AssemblyVersion>
40         <AssemblyVersion>4.0.0.0</AssemblyVersion>
41       </AssemblyInfo>
42       <ReturnValue>
43         <ReturnType>System.Void</ReturnType>
44       </ReturnValue>
45       <Parameters>
46         <Parameter Name="algorithmId" Type="System.Guid" />
47         <Parameter Name="checkSum" Type="System.Byte[]" />
48       </Parameters>
49       <Docs>
50         <remarks>
51           <attribution license="cc4" from="Microsoft" modified="false" />
52           <para>Sets the checksum for the document.</para>
53         </remarks>
54         <summary>
55           <attribution license="cc4" from="Microsoft" modified="false" />
56           <para>Sets checksum information.</para>
57         </summary>
58         <param name="algorithmId">
59           <attribution license="cc4" from="Microsoft" modified="false" />The GUID representing the algorithm ID. </param>
60         <param name="checkSum">
61           <attribution license="cc4" from="Microsoft" modified="false" />The checksum. </param>
62       </Docs>
63     </Member>
64     <Member MemberName="SetSource">
65       <MemberSignature Language="C#" Value="public void SetSource (byte[] source);" />
66       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetSource(unsigned int8[] source) cil managed" />
67       <MemberType>Method</MemberType>
68       <AssemblyInfo>
69         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
70         <AssemblyVersion>2.0.0.0</AssemblyVersion>
71         <AssemblyVersion>4.0.0.0</AssemblyVersion>
72       </AssemblyInfo>
73       <ReturnValue>
74         <ReturnType>System.Void</ReturnType>
75       </ReturnValue>
76       <Parameters>
77         <Parameter Name="source" Type="System.Byte[]" />
78       </Parameters>
79       <Docs>
80         <remarks>
81           <attribution license="cc4" from="Microsoft" modified="false" />
82           <para>An array of unsigned bytes is used instead of character data to accommodate a wider variety of sources.</para>
83         </remarks>
84         <summary>
85           <attribution license="cc4" from="Microsoft" modified="false" />
86           <para>Stores the raw source for a document in the symbol store.</para>
87         </summary>
88         <param name="source">
89           <attribution license="cc4" from="Microsoft" modified="false" />The document source represented as unsigned bytes. </param>
90       </Docs>
91     </Member>
92   </Members>
93 </Type>