dotnet-api-docs/xml/System.Security.Cryptography.X509Certificates/X500RelativeDistinguishedName.xml at main · dotnet/dotnet-api-docs · GitHub

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
<Type Name="X500RelativeDistinguishedName" FullName="System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName">
  <TypeSignature Language="C#" Value="public sealed class X500RelativeDistinguishedName" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit X500RelativeDistinguishedName extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class X500RelativeDistinguishedName" />
  <TypeSignature Language="F#" Value="type X500RelativeDistinguishedName = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class X500RelativeDistinguishedName sealed" />
  <AssemblyInfo>
    <AssemblyName>System.Security.Cryptography</AssemblyName>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents a Relative Distinguished Name component of an X.500 Distinguished Name.</summary>
    <remarks>To be added.</remarks>
    <seealso cref="T:System.Security.Cryptography.X509Certificates.X500DistinguishedName" />
  </Docs>
  <Members>
    <Member MemberName="GetSingleElementType">
      <MemberSignature Language="C#" Value="public System.Security.Cryptography.Oid GetSingleElementType ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Security.Cryptography.Oid GetSingleElementType() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.GetSingleElementType" />
      <MemberSignature Language="VB.NET" Value="Public Function GetSingleElementType () As Oid" />
      <MemberSignature Language="F#" Value="member this.GetSingleElementType : unit -&gt; System.Security.Cryptography.Oid" Usage="x500RelativeDistinguishedName.GetSingleElementType " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Security::Cryptography::Oid ^ GetSingleElementType();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Security.Cryptography</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Security.Cryptography.Oid</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the object identifier (OID) identifying the single attribute value for this Relative Distinguished Name (RDN), when the RDN only contains one attribute.</summary>
        <returns>The object identifier (OID) identifying the single attribute value for this Relative Distinguished Name (RDN).</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.InvalidOperationException">The Relative Distinguished Name has multiple attributes (<see cref="P:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.HasMultipleElements" />
              is <see langword="true" />).</exception>
      </Docs>
    </Member>
    <Member MemberName="GetSingleElementValue">
      <MemberSignature Language="C#" Value="public string? GetSingleElementValue ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetSingleElementValue() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.GetSingleElementValue" />
      <MemberSignature Language="VB.NET" Value="Public Function GetSingleElementValue () As String" />
      <MemberSignature Language="F#" Value="member this.GetSingleElementValue : unit -&gt; string" Usage="x500RelativeDistinguishedName.GetSingleElementValue " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::String ^ GetSingleElementValue();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Security.Cryptography</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the textual representation of the value for the Relative Distinguished Name (RDN), when the RDN only contains one attribute.</summary>
        <returns>The decoded text representing the attribute value.
              If the attribute value is an <c>OCTET STRING</c>, or other non-text data type, this method returns <see langword="null" />.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.Security.Cryptography.CryptographicException">The attribute is identified as a textual value, but the value did not successfully decode.</exception>
        <exception cref="T:System.InvalidOperationException">The Relative Distinguished Name has multiple attributes (<see cref="P:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.HasMultipleElements" />
              is <see langword="true" />).</exception>
      </Docs>
    </Member>
    <Member MemberName="HasMultipleElements">
      <MemberSignature Language="C#" Value="public bool HasMultipleElements { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool HasMultipleElements" />
      <MemberSignature Language="DocId" Value="P:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.HasMultipleElements" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property HasMultipleElements As Boolean" />
      <MemberSignature Language="F#" Value="member this.HasMultipleElements : bool" Usage="System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.HasMultipleElements" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool HasMultipleElements { bool get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Security.Cryptography</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a value that indicates whether this Relative Distinguished Name is composed of multiple attributes or only a single attribute.</summary>
        <value>
          <see langword="true" /> if the Relative Distinguished Name is composed of multiple attributes; <see langword="false" /> if it is composed of only a single attribute.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RawData">
      <MemberSignature Language="C#" Value="public ReadOnlyMemory&lt;byte&gt; RawData { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.ReadOnlyMemory`1&lt;unsigned int8&gt; RawData" />
      <MemberSignature Language="DocId" Value="P:System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.RawData" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property RawData As ReadOnlyMemory(Of Byte)" />
      <MemberSignature Language="F#" Value="member this.RawData : ReadOnlyMemory&lt;byte&gt;" Usage="System.Security.Cryptography.X509Certificates.X500RelativeDistinguishedName.RawData" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property ReadOnlyMemory&lt;System::Byte&gt; RawData { ReadOnlyMemory&lt;System::Byte&gt; get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Security.Cryptography</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ReadOnlyMemory&lt;System.Byte&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the encoded representation of this Relative Distinguished Name.</summary>
        <value>The encoded representation of this Relative Distinguished Name.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>