-
Notifications
You must be signed in to change notification settings - Fork 256
/
Throw.xml
186 lines (186 loc) · 10.8 KB
/
Throw.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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<Type Name="Throw" FullName="Microsoft.Azure.Search.Common.Throw">
<TypeSignature Language="C#" Value="public static class Throw" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit Throw extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Common.Throw" />
<TypeSignature Language="VB.NET" Value="Public Class Throw" />
<TypeSignature Language="F#" Value="type Throw = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Defines utility methods for validating arguments.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="IfArgument">
<MemberSignature Language="C#" Value="public static void IfArgument (bool isInvalid, string paramName, string message = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void IfArgument(bool isInvalid, string paramName, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Common.Throw.IfArgument(System.Boolean,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub IfArgument (isInvalid As Boolean, paramName As String, Optional message As String = Nothing)" />
<MemberSignature Language="F#" Value="static member IfArgument : bool * string * string -> unit" Usage="Microsoft.Azure.Search.Common.Throw.IfArgument (isInvalid, paramName, message)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="isInvalid" Type="System.Boolean" />
<Parameter Name="paramName" Type="System.String" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="isInvalid">The flag to test. This method throws if it's true and does nothing if
it's false.</param>
<param name="paramName">The name of the parameter being validated. This is passed to the
ArgumentException constructor.</param>
<param name="message">An optional error message to include in the ArgumentException. The default
message is "Invalid argument."</param>
<summary>
Throws ArgumentException with the given parameter name and optional message if the given Boolean
value is true.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IfArgumentNull<T>">
<MemberSignature Language="C#" Value="public static void IfArgumentNull<T> (T value, string paramName, string message = default) where T : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void IfArgumentNull<class T>(!!T value, string paramName, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Common.Throw.IfArgumentNull``1(``0,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub IfArgumentNull(Of T As Class) (value As T, paramName As String, Optional message As String = Nothing)" />
<MemberSignature Language="F#" Value="static member IfArgumentNull : 'T * string * string -> unit (requires 'T : null)" Usage="Microsoft.Azure.Search.Common.Throw.IfArgumentNull (value, paramName, message)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="paramName" Type="System.String" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">The type of value to test. Must be a reference type.</typeparam>
<param name="value">The reference to test for null.</param>
<param name="paramName">The name of the parameter being validated. This is passed to the
ArgumentNullException constructor.</param>
<param name="message">An optional error message to include in the ArgumentNullException.</param>
<summary>
Throws ArgumentNullException with the given parameter name and optional message if the given
reference is null.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IfArgumentNullOrEmpty">
<MemberSignature Language="C#" Value="public static void IfArgumentNullOrEmpty (string value, string paramName, string message = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void IfArgumentNullOrEmpty(string value, string paramName, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Common.Throw.IfArgumentNullOrEmpty(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub IfArgumentNullOrEmpty (value As String, paramName As String, Optional message As String = Nothing)" />
<MemberSignature Language="F#" Value="static member IfArgumentNullOrEmpty : string * string * string -> unit" Usage="Microsoft.Azure.Search.Common.Throw.IfArgumentNullOrEmpty (value, paramName, message)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
<Parameter Name="paramName" Type="System.String" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="value">The string to test for null or empty.</param>
<param name="paramName">The name of the parameter being validated. This is passed to the
ArgumentNullException or ArgumentException constructor.</param>
<param name="message">An optional error message to include in the ArgumentNullException
or ArgumentException.</param>
<summary>
Throws ArgumentNullException or ArgumentException with the given parameter name and optional message
if the given string is null or empty, respectively.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IfArgumentOutOfRange">
<MemberSignature Language="C#" Value="public static void IfArgumentOutOfRange (bool isInvalid, string paramName, string message = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void IfArgumentOutOfRange(bool isInvalid, string paramName, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Common.Throw.IfArgumentOutOfRange(System.Boolean,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub IfArgumentOutOfRange (isInvalid As Boolean, paramName As String, Optional message As String = Nothing)" />
<MemberSignature Language="F#" Value="static member IfArgumentOutOfRange : bool * string * string -> unit" Usage="Microsoft.Azure.Search.Common.Throw.IfArgumentOutOfRange (isInvalid, paramName, message)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="isInvalid" Type="System.Boolean" />
<Parameter Name="paramName" Type="System.String" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="isInvalid">The flag to test. This method throws if it's true and does nothing if
it's false.</param>
<param name="paramName">The name of the parameter being validated. This is passed to the
ArgumentOutOfRangeException constructor.</param>
<param name="message">An optional error message to include in the ArgumentOutOfRangeException. The default
message is "Argument out of range."</param>
<summary>
Throws ArgumentOutOfRangeException with the given parameter name and optional message if the given Boolean
value is true.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IfNullOrEmptySearchServiceName">
<MemberSignature Language="C#" Value="public static void IfNullOrEmptySearchServiceName (string searchServiceName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void IfNullOrEmptySearchServiceName(string searchServiceName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Common.Throw.IfNullOrEmptySearchServiceName(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub IfNullOrEmptySearchServiceName (searchServiceName As String)" />
<MemberSignature Language="F#" Value="static member IfNullOrEmptySearchServiceName : string -> unit" Usage="Microsoft.Azure.Search.Common.Throw.IfNullOrEmptySearchServiceName searchServiceName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Common</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="searchServiceName" Type="System.String" />
</Parameters>
<Docs>
<param name="searchServiceName">The search service name to validate.</param>
<summary>
Throws ArgumentNullException or ArgumentException with a pre-determined message if the given search
service name is null or empty, respectively.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>