-
Notifications
You must be signed in to change notification settings - Fork 256
/
CompositeTableKey.xml
156 lines (156 loc) · 9.33 KB
/
CompositeTableKey.xml
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<Type Name="CompositeTableKey" FullName="Microsoft.Azure.Mobile.Server.CompositeTableKey">
<TypeSignature Language="C#" Value="public class CompositeTableKey" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CompositeTableKey extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" />
<TypeSignature Language="VB.NET" Value="Public Class CompositeTableKey" />
<TypeSignature Language="F#" Value="type CompositeTableKey = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Tables</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A <see cref="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" /> contains one or more keys used to identify a single row in a table.
The string format of a <see cref="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" /> is a comma separated list (without LWS) of optionally single-quoted terms.
The terms only have to be quoted if they contain a comma.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CompositeTableKey (params string[] segments);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string[] segments) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.CompositeTableKey.#ctor(System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (ParamArray segments As String())" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Mobile.Server.CompositeTableKey : string[] -> Microsoft.Azure.Mobile.Server.CompositeTableKey" Usage="new Microsoft.Azure.Mobile.Server.CompositeTableKey segments" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Tables</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="segments" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="segments">The ordered set of <see cref="T:System.String" /> segments making up the composite key.</param>
<summary>
Initialize a new instance of the <see cref="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" /> with a given number of <see cref="T:System.String" />
representing an ordered list of segments making up the composite key.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Mobile.Server.CompositeTableKey Parse (string tableKey);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Mobile.Server.CompositeTableKey Parse(string tableKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.CompositeTableKey.Parse(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Parse (tableKey As String) As CompositeTableKey" />
<MemberSignature Language="F#" Value="static member Parse : string -> Microsoft.Azure.Mobile.Server.CompositeTableKey" Usage="Microsoft.Azure.Mobile.Server.CompositeTableKey.Parse tableKey" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Tables</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Mobile.Server.CompositeTableKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tableKey" Type="System.String" />
</Parameters>
<Docs>
<param name="tableKey">The value containing the composite key.</param>
<summary>
Parse a string as a <see cref="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" />. The value has to be a comma separated list (without LWS) of optionally single-quoted terms.
If the value is not valid then an <see cref="T:System.ArgumentException" /> is thrown.
</summary>
<returns>A new <see cref="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Segments">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<string> Segments { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<string> Segments" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Mobile.Server.CompositeTableKey.Segments" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Segments As Collection(Of String)" />
<MemberSignature Language="F#" Value="member this.Segments : System.Collections.ObjectModel.Collection<string>" Usage="Microsoft.Azure.Mobile.Server.CompositeTableKey.Segments" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Tables</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the ordered <see cref="T:System.Collections.ObjectModel.Collection`1" /> of segments making up the composite key.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.CompositeTableKey.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="compositeTableKey.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Tables</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Generates a <see cref="T:System.String" /> representation of the composite key.
</summary>
<returns>A <see cref="T:System.String" /> representation of the composite key.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryParse">
<MemberSignature Language="C#" Value="public static bool TryParse (string tableKey, out Microsoft.Azure.Mobile.Server.CompositeTableKey compositeTableKey);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParse(string tableKey, [out] class Microsoft.Azure.Mobile.Server.CompositeTableKey& compositeTableKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Mobile.Server.CompositeTableKey.TryParse(System.String,Microsoft.Azure.Mobile.Server.CompositeTableKey@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryParse (tableKey As String, ByRef compositeTableKey As CompositeTableKey) As Boolean" />
<MemberSignature Language="F#" Value="static member TryParse : string * CompositeTableKey -> bool" Usage="Microsoft.Azure.Mobile.Server.CompositeTableKey.TryParse (tableKey, compositeTableKey)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Mobile.Server.Tables</AssemblyName>
<AssemblyVersion>2.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tableKey" Type="System.String" />
<Parameter Name="compositeTableKey" Type="Microsoft.Azure.Mobile.Server.CompositeTableKey" RefType="out" />
</Parameters>
<Docs>
<param name="tableKey">The value containing the composite key.</param>
<param name="compositeTableKey">If the method returns <c>true</c> then <paramref name="compositeTableKey" /> contains the result; otherwise <c>null</c>.</param>
<summary>
Attempts creating a new <see cref="T:Microsoft.Azure.Mobile.Server.CompositeTableKey" /> from a given <paramref name="tableKey" />.
The return value indicates whether the parsing succeeded.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>