forked from dotnet/dotnet-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCollectionsMarshal.xml
More file actions
96 lines (93 loc) · 6.22 KB
/
CollectionsMarshal.xml
File metadata and controls
96 lines (93 loc) · 6.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<Type Name="CollectionsMarshal" FullName="System.Runtime.InteropServices.CollectionsMarshal">
<TypeSignature Language="C#" Value="public static class CollectionsMarshal" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit CollectionsMarshal extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Runtime.InteropServices.CollectionsMarshal" />
<TypeSignature Language="VB.NET" Value="Public Class CollectionsMarshal" />
<TypeSignature Language="F#" Value="type CollectionsMarshal = class" />
<TypeSignature Language="C++ CLI" Value="public ref class CollectionsMarshal abstract sealed" />
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>An unsafe class that provides a set of methods to access the underlying data representations of collections.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AsSpan<T>">
<MemberSignature Language="C#" Value="public static Span<T> AsSpan<T> (System.Collections.Generic.List<T>? list);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype System.Span`1<!!T> AsSpan<T>(class System.Collections.Generic.List`1<!!T> list) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.InteropServices.CollectionsMarshal.AsSpan``1(System.Collections.Generic.List{``0})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function AsSpan(Of T) (list As List(Of T)) As Span(Of T)" />
<MemberSignature Language="F#" Value="static member AsSpan : System.Collections.Generic.List<'T> -> Span<'T>" Usage="System.Runtime.InteropServices.CollectionsMarshal.AsSpan list" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 static Span<T> AsSpan(System::Collections::Generic::List<T> ^ list);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Span<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="list" Type="System.Collections.Generic.List<T>" />
</Parameters>
<Docs>
<typeparam name="T">The type of items in the list.</typeparam>
<param name="list">List from which to create the <see cref="T:System.Span`1" />.</param>
<summary>Gets a <see cref="T:System.Span`1" /> view over the data in a list.
Items should not be added or removed from the <see cref="T:System.Collections.Generic.List`1" /> while the <see cref="T:System.Span`1" /> is in use.</summary>
<returns>A <see cref="T:System.Span`1" /> instance over the <see cref="T:System.Collections.Generic.List`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetValueRefOrNullRef<TKey,TValue>">
<MemberSignature Language="C#" Value="public static ref TValue GetValueRefOrNullRef<TKey,TValue> (System.Collections.Generic.Dictionary<TKey,TValue> dictionary, TKey key);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TValue GetValueRefOrNullRef<TKey, TValue>(class System.Collections.Generic.Dictionary`2<!!TKey, !!TValue> dictionary, !!TKey key) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrNullRef``2(System.Collections.Generic.Dictionary{``0,``1},``0)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GetValueRefOrNullRef(Of TKey, TValue) (dictionary As Dictionary(Of TKey, TValue), key As TKey) As TValue" />
<MemberSignature Language="F#" Value="static member GetValueRefOrNullRef : System.Collections.Generic.Dictionary<'Key, 'Value> * 'Key -> 'Value" Usage="System.Runtime.InteropServices.CollectionsMarshal.GetValueRefOrNullRef (dictionary, key)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TKey, typename TValue>
 static TValue % GetValueRefOrNullRef(System::Collections::Generic::Dictionary<TKey, TValue> ^ dictionary, TKey key);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TValue</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TKey" />
<TypeParameter Name="TValue" />
</TypeParameters>
<Parameters>
<Parameter Name="dictionary" Type="System.Collections.Generic.Dictionary<TKey,TValue>" Index="0" FrameworkAlternate="net-6.0" />
<Parameter Name="key" Type="TKey" Index="1" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<typeparam name="TKey">To be added.</typeparam>
<typeparam name="TValue">To be added.</typeparam>
<param name="dictionary">The dictionary to get the ref to <typeparamref name="TValue" /> from.</param>
<param name="key">The key used for lookup.</param>
<summary>Gets either a ref to a <typeparamref name="TValue" /> in the <see cref="T:System.Collections.Generic.Dictionary`2" /> or a ref <see langword="null" /> if it does not exist in the <paramref name="dictionary" />.</summary>
<returns>To be added.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Items should not be added or removed from the <xref:System.Collections.Generic.Dictionary`2> while the ref <typeparamref name="TValue> is in use.
The ref `null` can be detected using System.Runtime.CompilerServices.Unsafe.IsNullRef
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>