-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathAsnReader.xml
2228 lines (2073 loc) · 127 KB
/
AsnReader.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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="AsnReader" FullName="System.Formats.Asn1.AsnReader">
<TypeSignature Language="C#" Value="public class AsnReader" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AsnReader extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Formats.Asn1.AsnReader" />
<TypeSignature Language="VB.NET" Value="Public Class AsnReader" />
<TypeSignature Language="F#" Value="type AsnReader = class" />
<TypeSignature Language="C++ CLI" Value="public ref class AsnReader" />
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.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>
A stateful, forward-only reader for BER-, CER-, or DER-encoded ASN.1 data.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AsnReader (ReadOnlyMemory<byte> data, System.Formats.Asn1.AsnEncodingRules ruleSet, System.Formats.Asn1.AsnReaderOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ReadOnlyMemory`1<unsigned int8> data, valuetype System.Formats.Asn1.AsnEncodingRules ruleSet, valuetype System.Formats.Asn1.AsnReaderOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.#ctor(System.ReadOnlyMemory{System.Byte},System.Formats.Asn1.AsnEncodingRules,System.Formats.Asn1.AsnReaderOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (data As ReadOnlyMemory(Of Byte), ruleSet As AsnEncodingRules, Optional options As AsnReaderOptions = Nothing)" />
<MemberSignature Language="F#" Value="new System.Formats.Asn1.AsnReader : ReadOnlyMemory<byte> * System.Formats.Asn1.AsnEncodingRules * System.Formats.Asn1.AsnReaderOptions -> System.Formats.Asn1.AsnReader" Usage="new System.Formats.Asn1.AsnReader (data, ruleSet, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="data" Type="System.ReadOnlyMemory<System.Byte>" />
<Parameter Name="ruleSet" Type="System.Formats.Asn1.AsnEncodingRules" />
<Parameter Name="options" Type="System.Formats.Asn1.AsnReaderOptions" />
</Parameters>
<Docs>
<param name="data">The data to read.</param>
<param name="ruleSet">The encoding constraints for the reader.</param>
<param name="options">Additional options for the reader.</param>
<summary>
Construct an <see cref="T:System.Formats.Asn1.AsnReader" /> over <paramref name="data" /> with a given ruleset.
</summary>
<remarks>
This constructor does not evaluate <paramref name="data" /> for correctness.
Any correctness checks are done as part of member methods.
This constructor does not copy <paramref name="data" />. The caller is responsible for
ensuring that the values do not change until the reader is finished.
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="ruleSet" /> is not defined.
</exception>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public System.Formats.Asn1.AsnReader Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Formats.Asn1.AsnReader Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As AsnReader" />
<MemberSignature Language="F#" Value="member this.Clone : unit -> System.Formats.Asn1.AsnReader" Usage="asnReader.Clone " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Formats::Asn1::AsnReader ^ Clone();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Formats.Asn1.AsnReader</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Clones the current reader.
</summary>
<returns>A clone of the current reader.</returns>
<remarks>
This does not create a clone of the ASN.1 data, only the reader's state is cloned.
</remarks>
</Docs>
</Member>
<Member MemberName="HasData">
<MemberSignature Language="C#" Value="public bool HasData { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasData" />
<MemberSignature Language="DocId" Value="P:System.Formats.Asn1.AsnReader.HasData" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasData As Boolean" />
<MemberSignature Language="F#" Value="member this.HasData : bool" Usage="System.Formats.Asn1.AsnReader.HasData" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool HasData { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an indication of whether the reader has remaining data available to process.
</summary>
<value>
<see langword="true" /> if there is more data available for the reader to process;
otherwise, <see langword="false" />.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PeekContentBytes">
<MemberSignature Language="C#" Value="public ReadOnlyMemory<byte> PeekContentBytes ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.ReadOnlyMemory`1<unsigned int8> PeekContentBytes() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.PeekContentBytes" />
<MemberSignature Language="VB.NET" Value="Public Function PeekContentBytes () As ReadOnlyMemory(Of Byte)" />
<MemberSignature Language="F#" Value="member this.PeekContentBytes : unit -> ReadOnlyMemory<byte>" Usage="asnReader.PeekContentBytes " />
<MemberSignature Language="C++ CLI" Value="public:
 ReadOnlyMemory<System::Byte> PeekContentBytes();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlyMemory<System.Byte></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get a <see cref="T:System.ReadOnlyMemory`1" /> view of the content octets (bytes) of the
next encoded value without advancing the reader.
</summary>
<returns>
The bytes of the contents octets of the next encoded value.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The reader is positioned at a point where the tag or length is invalid
under the current encoding rules.
</exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.PeekEncodedValue" />
</Docs>
</Member>
<Member MemberName="PeekEncodedValue">
<MemberSignature Language="C#" Value="public ReadOnlyMemory<byte> PeekEncodedValue ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.ReadOnlyMemory`1<unsigned int8> PeekEncodedValue() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.PeekEncodedValue" />
<MemberSignature Language="VB.NET" Value="Public Function PeekEncodedValue () As ReadOnlyMemory(Of Byte)" />
<MemberSignature Language="F#" Value="member this.PeekEncodedValue : unit -> ReadOnlyMemory<byte>" Usage="asnReader.PeekEncodedValue " />
<MemberSignature Language="C++ CLI" Value="public:
 ReadOnlyMemory<System::Byte> PeekEncodedValue();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlyMemory<System.Byte></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get a <see cref="T:System.ReadOnlyMemory`1" /> view of the next encoded value without
advancing the reader. For indefinite length encodings this includes the
End of Contents marker.
</summary>
<returns>
The bytes of the next encoded value.
</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Formats.Asn1.AsnReader.ReadEncodedValue" />
<exception cref="T:System.Formats.Asn1.AsnContentException">
The reader is positioned at a point where the tag or length is invalid
under the current encoding rules.
</exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.PeekContentBytes" />
</Docs>
</Member>
<Member MemberName="PeekTag">
<MemberSignature Language="C#" Value="public System.Formats.Asn1.Asn1Tag PeekTag ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Formats.Asn1.Asn1Tag PeekTag() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.PeekTag" />
<MemberSignature Language="VB.NET" Value="Public Function PeekTag () As Asn1Tag" />
<MemberSignature Language="F#" Value="member this.PeekTag : unit -> System.Formats.Asn1.Asn1Tag" Usage="asnReader.PeekTag " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Formats::Asn1::Asn1Tag PeekTag();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Formats.Asn1.Asn1Tag</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Read the encoded tag at the next data position, without advancing the reader.
</summary>
<returns>
The decoded tag value.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
a tag could not be decoded at the reader's current position.
</exception>
</Docs>
</Member>
<Member MemberName="ReadBitString">
<MemberSignature Language="C#" Value="public byte[] ReadBitString (out int unusedBitCount, System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] ReadBitString([out] int32& unusedBitCount, valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadBitString(System.Int32@,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadBitString (ByRef unusedBitCount As Integer, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Byte()" />
<MemberSignature Language="F#" Value="member this.ReadBitString : int * Nullable<System.Formats.Asn1.Asn1Tag> -> byte[]" Usage="asnReader.ReadBitString (unusedBitCount, expectedTag)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.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="unusedBitCount" Type="System.Int32" RefType="out" />
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="unusedBitCount">
On success, receives the number of bits in the last byte which were reported as
"unused" by the writer.
</param>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 1).
</param>
<summary>
Reads the next value as a BIT STRING with a specified tag, returning the value
in a byte array.
</summary>
<returns>
A copy of the value in a newly allocated, precisely sized, array.
</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Formats.Asn1.AsnReader.TryReadBitString(System.Span{System.Byte},System.Int32@,System.Int32@,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.TryReadPrimitiveBitString(System.Int32@,System.ReadOnlyMemory{System.Byte}@,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
</Docs>
</Member>
<Member MemberName="ReadBoolean">
<MemberSignature Language="C#" Value="public bool ReadBoolean (System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ReadBoolean(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadBoolean(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadBoolean (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Boolean" />
<MemberSignature Language="F#" Value="member this.ReadBoolean : Nullable<System.Formats.Asn1.Asn1Tag> -> bool" Usage="asnReader.ReadBoolean expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 1).
</param>
<summary>
Reads the next value as a Boolean with a specified tag.
</summary>
<returns>
The decoded value.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
</Docs>
</Member>
<Member MemberName="ReadCharacterString">
<MemberSignature Language="C#" Value="public string ReadCharacterString (System.Formats.Asn1.UniversalTagNumber encodingType, System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ReadCharacterString(valuetype System.Formats.Asn1.UniversalTagNumber encodingType, valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadCharacterString(System.Formats.Asn1.UniversalTagNumber,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadCharacterString (encodingType As UniversalTagNumber, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As String" />
<MemberSignature Language="F#" Value="member this.ReadCharacterString : System.Formats.Asn1.UniversalTagNumber * Nullable<System.Formats.Asn1.Asn1Tag> -> string" Usage="asnReader.ReadCharacterString (encodingType, expectedTag)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="encodingType" Type="System.Formats.Asn1.UniversalTagNumber" />
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="encodingType">
One of the enumeration values representing the value type to process.
</param>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the universal tag that is
appropriate to the requested encoding type.
</param>
<summary>
Reads the next value as character string with the specified tag and
encoding type, returning the decoded value as a string.
</summary>
<returns>
The decoded value.
</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Formats.Asn1.AsnReader.TryReadCharacterString(System.Span{System.Char},System.Formats.Asn1.UniversalTagNumber,System.Int32@,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<altmember cref="M:System.Formats.Asn1.AsnReader.TryReadPrimitiveCharacterStringBytes(System.Formats.Asn1.Asn1Tag,System.ReadOnlyMemory{System.Byte}@)" />
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="encodingType" /> is not a known character string type.
</exception>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
-or-
The string did not successfully decode.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not the same as
<paramref name="encodingType" />.
</exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.TryReadCharacterStringBytes(System.Span{System.Byte},System.Formats.Asn1.Asn1Tag,System.Int32@)" />
</Docs>
</Member>
<Member MemberName="ReadEncodedValue">
<MemberSignature Language="C#" Value="public ReadOnlyMemory<byte> ReadEncodedValue ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.ReadOnlyMemory`1<unsigned int8> ReadEncodedValue() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadEncodedValue" />
<MemberSignature Language="VB.NET" Value="Public Function ReadEncodedValue () As ReadOnlyMemory(Of Byte)" />
<MemberSignature Language="F#" Value="member this.ReadEncodedValue : unit -> ReadOnlyMemory<byte>" Usage="asnReader.ReadEncodedValue " />
<MemberSignature Language="C++ CLI" Value="public:
 ReadOnlyMemory<System::Byte> ReadEncodedValue();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlyMemory<System.Byte></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get a <see cref="T:System.ReadOnlyMemory`1" /> view of the next encoded value,
and advance the reader past it. For an indefinite length encoding this includes
the End of Contents marker.
</summary>
<returns>
A <see cref="T:System.ReadOnlyMemory`1" /> view of the next encoded value.
</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Formats.Asn1.AsnReader.PeekEncodedValue" />
</Docs>
</Member>
<Member MemberName="ReadEnumeratedBytes">
<MemberSignature Language="C#" Value="public ReadOnlyMemory<byte> ReadEnumeratedBytes (System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.ReadOnlyMemory`1<unsigned int8> ReadEnumeratedBytes(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadEnumeratedBytes(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadEnumeratedBytes (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As ReadOnlyMemory(Of Byte)" />
<MemberSignature Language="F#" Value="member this.ReadEnumeratedBytes : Nullable<System.Formats.Asn1.Asn1Tag> -> ReadOnlyMemory<byte>" Usage="asnReader.ReadEnumeratedBytes expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlyMemory<System.Byte></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 10).
</param>
<summary>
Reads the next value as a Enumerated with a specified tag, returning the contents
as a <see cref="T:System.ReadOnlyMemory`1" /> over the original data.
</summary>
<returns>
The bytes of the Enumerated value, in signed big-endian form.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.ReadEnumeratedValue``1(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
</Docs>
</Member>
<Member MemberName="ReadEnumeratedValue">
<MemberSignature Language="C#" Value="public Enum ReadEnumeratedValue (Type enumType, System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Enum ReadEnumeratedValue(class System.Type enumType, valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadEnumeratedValue(System.Type,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadEnumeratedValue (enumType As Type, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Enum" />
<MemberSignature Language="F#" Value="member this.ReadEnumeratedValue : Type * Nullable<System.Formats.Asn1.Asn1Tag> -> Enum" Usage="asnReader.ReadEnumeratedValue (enumType, expectedTag)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Enum</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="enumType" Type="System.Type" />
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="enumType">Type object representing the destination type.</param>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 10).
</param>
<summary>
Reads the next value as an Enumerated with a specified tag, converting it to the
non-[<see cref="T:System.FlagsAttribute" />] enum specified by <paramref name="enumType" />.
</summary>
<returns>
The Enumerated value converted to a <paramref name="enumType" />.
</returns>
<remarks>
This method does not validate that the return value is defined within
<paramref name="enumType" />.
</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
-or-
The encoded value is too big to fit in a <paramref name="enumType" /> value.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="enumType" /> is not an enum type.
-or-
<paramref name="enumType" /> was declared with <see cref="T:System.FlagsAttribute" />.
-or-
<paramref name="enumType" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="enumType" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="enumType" /> is <see langword="null" />.
</exception>
</Docs>
</Member>
<Member MemberName="ReadEnumeratedValue<TEnum>">
<MemberSignature Language="C#" Value="public TEnum ReadEnumeratedValue<TEnum> (System.Formats.Asn1.Asn1Tag? expectedTag = default) where TEnum : Enum;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!TEnum ReadEnumeratedValue<(class System.Enum) TEnum>(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadEnumeratedValue``1(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadEnumeratedValue(Of TEnum As Enum) (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As TEnum" />
<MemberSignature Language="F#" Value="member this.ReadEnumeratedValue : Nullable<System.Formats.Asn1.Asn1Tag> -> 'Enum (requires 'Enum :> Enum)" Usage="asnReader.ReadEnumeratedValue expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEnum</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEnum">
<Constraints>
<BaseTypeName>System.Enum</BaseTypeName>
</Constraints>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-8.0-pp;net-9.0;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<typeparam name="TEnum">The destination enum type.</typeparam>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 10).
</param>
<summary>
Reads the next value as an Enumerated with a specified tag, converting it to the
non-[<see cref="T:System.FlagsAttribute" />] enum specified by <typeparamref name="TEnum" />.
</summary>
<returns>
The Enumerated value converted to a <typeparamref name="TEnum" />.
</returns>
<remarks>
This method does not validate that the return value is defined within
<typeparamref name="TEnum" />.
</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
-or-
The encoded value is too big to fit in a <typeparamref name="TEnum" /> value.
</exception>
<exception cref="T:System.ArgumentException">
<typeparamref name="TEnum" /> is not an enum type.
-or-
<typeparamref name="TEnum" /> was declared with <see cref="T:System.FlagsAttribute" />.
-or-
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
</Docs>
</Member>
<Member MemberName="ReadGeneralizedTime">
<MemberSignature Language="C#" Value="public DateTimeOffset ReadGeneralizedTime (System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.DateTimeOffset ReadGeneralizedTime(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadGeneralizedTime(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadGeneralizedTime (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.ReadGeneralizedTime : Nullable<System.Formats.Asn1.Asn1Tag> -> DateTimeOffset" Usage="asnReader.ReadGeneralizedTime expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 24).
</param>
<summary>
Reads the next value as a GeneralizedTime with a specified tag.
</summary>
<returns>
The decoded value.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
</Docs>
</Member>
<Member MemberName="ReadInteger">
<MemberSignature Language="C#" Value="public System.Numerics.BigInteger ReadInteger (System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Numerics.BigInteger ReadInteger(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadInteger(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadInteger (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As BigInteger" />
<MemberSignature Language="F#" Value="member this.ReadInteger : Nullable<System.Formats.Asn1.Asn1Tag> -> System.Numerics.BigInteger" Usage="asnReader.ReadInteger expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Numerics.BigInteger</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 2).
</param>
<summary>
Reads the next value as an Integer with a specified tag.
</summary>
<returns>
The decoded value.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
</Docs>
</Member>
<Member MemberName="ReadIntegerBytes">
<MemberSignature Language="C#" Value="public ReadOnlyMemory<byte> ReadIntegerBytes (System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.ReadOnlyMemory`1<unsigned int8> ReadIntegerBytes(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadIntegerBytes(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadIntegerBytes (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As ReadOnlyMemory(Of Byte)" />
<MemberSignature Language="F#" Value="member this.ReadIntegerBytes : Nullable<System.Formats.Asn1.Asn1Tag> -> ReadOnlyMemory<byte>" Usage="asnReader.ReadIntegerBytes expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlyMemory<System.Byte></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="expectedTag">
The tag to check for before reading, or <see langword="null" /> for the default tag (Universal 2).
</param>
<summary>
Reads the next value as a Integer with a specified tag, returning the contents
as a <see cref="T:System.ReadOnlyMemory`1" /> over the original data.
</summary>
<returns>
The bytes of the Integer value, in signed big-endian form.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
</Docs>
</Member>
<Member MemberName="ReadNamedBitList">
<MemberSignature Language="C#" Value="public System.Collections.BitArray ReadNamedBitList (System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.BitArray ReadNamedBitList(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadNamedBitList(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadNamedBitList (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As BitArray" />
<MemberSignature Language="F#" Value="member this.ReadNamedBitList : Nullable<System.Formats.Asn1.Asn1Tag> -> System.Collections.BitArray" Usage="asnReader.ReadNamedBitList expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.BitArray</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="expectedTag">The tag to check for before reading.</param>
<summary>
Reads the next value as a NamedBitList with a specified tag.
</summary>
<returns>
The bits from the encoded value.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.ReadNamedBitListValue``1(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
</Docs>
</Member>
<Member MemberName="ReadNamedBitListValue">
<MemberSignature Language="C#" Value="public Enum ReadNamedBitListValue (Type flagsEnumType, System.Formats.Asn1.Asn1Tag? expectedTag = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Enum ReadNamedBitListValue(class System.Type flagsEnumType, valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadNamedBitListValue(System.Type,System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadNamedBitListValue (flagsEnumType As Type, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Enum" />
<MemberSignature Language="F#" Value="member this.ReadNamedBitListValue : Type * Nullable<System.Formats.Asn1.Asn1Tag> -> Enum" Usage="asnReader.ReadNamedBitListValue (flagsEnumType, expectedTag)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Enum</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="flagsEnumType" Type="System.Type" />
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<param name="flagsEnumType">Type object representing the destination type.</param>
<param name="expectedTag">The tag to check for before reading.</param>
<summary>
Reads the next value as a NamedBitList with a specified tag, converting it to the
[<see cref="T:System.FlagsAttribute" />] enum specified by <paramref name="flagsEnumType" />.
</summary>
<returns>
The NamedBitList value converted to a <paramref name="flagsEnumType" />.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Formats.Asn1.AsnContentException">
The next value does not have the correct tag.
-or-
The length encoding is not valid under the current encoding rules.
-or-
The contents are not valid under the current encoding rules.
-or-
The encoded value is too big to fit in a <paramref name="flagsEnumType" /> value.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="flagsEnumType" /> is not an enum type.
-or-
<paramref name="flagsEnumType" /> was not declared with <see cref="T:System.FlagsAttribute" />
-or-
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagClass" /> is
<see cref="F:System.Formats.Asn1.TagClass.Universal" />, but
<paramref name="expectedTag" />.<see cref="P:System.Formats.Asn1.Asn1Tag.TagValue" /> is not correct for
the method.
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="flagsEnumType" /> is <see langword="null" /></exception>
<altmember cref="M:System.Formats.Asn1.AsnReader.ReadNamedBitListValue``1(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
</Docs>
</Member>
<Member MemberName="ReadNamedBitListValue<TFlagsEnum>">
<MemberSignature Language="C#" Value="public TFlagsEnum ReadNamedBitListValue<TFlagsEnum> (System.Formats.Asn1.Asn1Tag? expectedTag = default) where TFlagsEnum : Enum;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!TFlagsEnum ReadNamedBitListValue<(class System.Enum) TFlagsEnum>(valuetype System.Nullable`1<valuetype System.Formats.Asn1.Asn1Tag> expectedTag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Formats.Asn1.AsnReader.ReadNamedBitListValue``1(System.Nullable{System.Formats.Asn1.Asn1Tag})" />
<MemberSignature Language="VB.NET" Value="Public Function ReadNamedBitListValue(Of TFlagsEnum As Enum) (Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As TFlagsEnum" />
<MemberSignature Language="F#" Value="member this.ReadNamedBitListValue : Nullable<System.Formats.Asn1.Asn1Tag> -> 'FlagsEnum (requires 'FlagsEnum :> Enum)" Usage="asnReader.ReadNamedBitListValue expectedTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Formats.Asn1</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TFlagsEnum</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TFlagsEnum">
<Constraints>
<BaseTypeName>System.Enum</BaseTypeName>
</Constraints>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-8.0-pp;net-9.0;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="expectedTag" Type="System.Nullable<System.Formats.Asn1.Asn1Tag>" />
</Parameters>
<Docs>
<typeparam name="TFlagsEnum">The destination enum type.</typeparam>
<param name="expectedTag">The tag to check for before reading.</param>
<summary>
Reads the next value as a NamedBitList with a specified tag, converting it to the
[<see cref="T:System.FlagsAttribute" />] enum specified by <typeparamref name="TFlagsEnum" />.
</summary>
<returns>
The NamedBitList value converted to a <typeparamref name="TFlagsEnum" />.
</returns>
<remarks>
The bit alignment performed by this method is to interpret the most significant bit
in the first byte of the value as the least significant bit in <typeparamref name="TFlagsEnum" />,
with bits increasing in value until the least significant bit of the first byte, proceeding
with the most significant bit of the second byte, and so on. Under this scheme, the following
ASN.1 type declaration and C# enumeration can be used together:
<code>
KeyUsage ::= BIT STRING {
digitalSignature (0),
nonRepudiation (1),
keyEncipherment (2),
dataEncipherment (3),
keyAgreement (4),
keyCertSign (5),
cRLSign (6),
encipherOnly (7),
decipherOnly (8) }
</code><code>
[Flags]
enum KeyUsage
{
None = 0,
DigitalSignature = 1 << (0),
NonRepudiation = 1 << (1),
KeyEncipherment = 1 << (2),
DataEncipherment = 1 << (3),
KeyAgreement = 1 << (4),
KeyCertSign = 1 << (5),
CrlSign = 1 << (6),
EncipherOnly = 1 << (7),
DecipherOnly = 1 << (8),
}
</code>
While the example here uses the KeyUsage NamedBitList from
<a href="https://tools.ietf.org/html/rfc3280#section-4.2.1.3">RFC 3280 (4.2.1.3)</a>,
the example enum uses values that are different from
System.Security.Cryptography.X509Certificates.X509KeyUsageFlags.
</remarks>