/
BerConverter.xml
168 lines (142 loc) · 9.83 KB
/
BerConverter.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
<Type Name="BerConverter" FullName="System.DirectoryServices.Protocols.BerConverter">
<TypeSignature Language="C#" Value="public static class BerConverter" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.0" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit BerConverter extends System.Object" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.0" />
<TypeSignature Language="DocId" Value="T:System.DirectoryServices.Protocols.BerConverter" />
<TypeSignature Language="VB.NET" Value="Public Class BerConverter" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.0" />
<TypeSignature Language="F#" Value="type BerConverter = class" />
<TypeSignature Language="C++ CLI" Value="public ref class BerConverter abstract sealed" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netstandard-2.0" />
<TypeSignature Language="C#" Value="public sealed class BerConverter" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BerConverter extends System.Object" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class BerConverter" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<TypeSignature Language="C++ CLI" Value="public ref class BerConverter sealed" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<AssemblyInfo>
<AssemblyName>System.DirectoryServices.Protocols</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>The <see cref="T:System.DirectoryServices.Protocols.BerConverter" /> class encodes and decodes structured data using basic encoding rules (BER).</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Decode">
<MemberSignature Language="C#" Value="public static object[] Decode (string format, byte[] value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig object[] Decode(string format, unsigned int8[] value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.DirectoryServices.Protocols.BerConverter.Decode(System.String,System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Decode (format As String, value As Byte()) As Object()" />
<MemberSignature Language="F#" Value="static member Decode : string * byte[] -> obj[]" Usage="System.DirectoryServices.Protocols.BerConverter.Decode (format, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::Object ^> ^ Decode(System::String ^ format, cli::array <System::Byte> ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.DirectoryServices.Protocols</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="value" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="format">The format string.</param>
<param name="value">An array of BER data.</param>
<summary>The <see cref="M:System.DirectoryServices.Protocols.BerConverter.Decode(System.String,System.Byte[])" /> method decodes a binary representation of the data, using BER, to retrieve structured data.</summary>
<returns>The decoded data.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="format" /> parameter contains a null reference (<see langword="Nothing" /> in Visual Basic).</exception>
<exception cref="T:System.ArgumentException">The <paramref name="format" /> parameter contains an undefined character.</exception>
<exception cref="T:System.DirectoryServices.Protocols.BerConversionException">The underlying decoding fails. The decoding rules include the following.
<list type="table"><listheader><term> Code
</term><description> Corresponding Result
</description></listheader><item><term> '{' '}' '[' ']' 'n' 'x'
</term><description> No corresponding result
</description></item><item><term> 'i' 'e'
</term><description> int
</description></item><item><term> 'b'
</term><description> bool
</description></item><item><term> 'a'
</term><description> string
</description></item><item><term> 'O'
</term><description> byte[]
</description></item><item><term> 'B'
</term><description> byte[] containing bit strings
</description></item><item><term> 'v'
</term><description> string[]
</description></item><item><term> 'V'
</term><description> byte[][]
</description></item></list></exception>
</Docs>
</Member>
<Member MemberName="Encode">
<MemberSignature Language="C#" Value="public static byte[] Encode (string format, params object[] value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] Encode(string format, object[] value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.DirectoryServices.Protocols.BerConverter.Encode(System.String,System.Object[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Encode (format As String, ParamArray value As Object()) As Byte()" />
<MemberSignature Language="F#" Value="static member Encode : string * obj[] -> byte[]" Usage="System.DirectoryServices.Protocols.BerConverter.Encode (format, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::Byte> ^ Encode(System::String ^ format, ... cli::array <System::Object ^> ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.DirectoryServices.Protocols</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.String" />
<Parameter Name="value" Type="System.Object[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="format">The format string.</param>
<param name="value">An array of formatted data.</param>
<summary>The <see cref="M:System.DirectoryServices.Protocols.BerConverter.Encode(System.String,System.Object[])" /> method encodes structured data, using BER, to retrieve a binary representation of the data.</summary>
<returns>An array of BER-encoded data.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following are valid format characters.
Encoding rules:
|Code|Corresponding Argument|
|----------|----------------------------|
|'{' '}' '[' ']' 'n'|No corresponding argument|
|'t' 'i' 'e'|int|
|'a'|Octet string|
|'b'|bool|
|'s'|string|
|'o' 'X'|byte[]|
|'v'|string[]|
|'V'|byte[][]|
> [!NOTE]
> 'v' and 'V' are special in that a double {} is required. For example, use {{v}} and {{V}}.
## Exceptions
|Exception|Condition|
|---------------|---------------|
|ArgumentNullException|`format` is a null reference (`Nothing` in Visual Basic).|
|ArgumentException|This exception occurs in any one of the following conditions:<br /><br /> - There are not enough arguments for the format string.<br />- The format string argument is incorrect.<br />- The format string contains an undefined character.|
|BerConversionException|Error processing return value.|
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>