linux-packaging-mono/mcs/class/System.ServiceModel/Documentation/en/System.ServiceModel.Security/X509CertificateRecipientServiceCredential.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="X509CertificateRecipientServiceCredential" FullName="System.ServiceModel.Security.X509CertificateRecipientServiceCredential">
  <TypeSignature Language="C#" Value="public sealed class X509CertificateRecipientServiceCredential" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit X509CertificateRecipientServiceCredential extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>System.ServiceModel</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>To be added.</remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Defines a certificate used by a service to identify itself.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName="Certificate">
      <MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This property is used to get or set the certificate used to represent the service.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the certificate to use for representing the service when communicating back to the client.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="SetCertificate">
      <MemberSignature Language="C#" Value="public void SetCertificate (string subjectName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCertificate(string subjectName) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="subjectName" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>For more information on the <paramref name="subjectName" /> parameter, see <see cref="P:System.Security.Cryptography.X509Certificates.X509Certificate2.SubjectName" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Specifies the certificate to use for representing the service by specifying the subject distinguished name.</para>
        </summary>
        <param name="subjectName">
          <attribution license="cc4" from="Microsoft" modified="false" />Subject distinguished name.</param>
      </Docs>
    </Member>
    <Member MemberName="SetCertificate">
      <MemberSignature Language="C#" Value="public void SetCertificate (string subjectName, System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, System.Security.Cryptography.X509Certificates.StoreName storeName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCertificate(string subjectName, valuetype System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, valuetype System.Security.Cryptography.X509Certificates.StoreName storeName) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="subjectName" Type="System.String" />
        <Parameter Name="storeLocation" Type="System.Security.Cryptography.X509Certificates.StoreLocation" />
        <Parameter Name="storeName" Type="System.Security.Cryptography.X509Certificates.StoreName" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>For more information on the <paramref name="subjectName" /> parameter, see <see cref="P:System.Security.Cryptography.X509Certificates.X509Certificate2.SubjectName" />.</para>
          <para>Values for <paramref name="storeLocation" /> are included in the <see cref="T:System.Security.Cryptography.X509Certificates.StoreLocation" /> enumeration:</para>
          <list type="bullet">
            <item>
              <para>
                <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.LocalMachine" />: the certificate store assigned to the local machine (default).</para>
            </item>
            <item>
              <para>
                <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.CurrentUser" />: the certificate store used by the current user.</para>
            </item>
          </list>
          <para>If the client application is running under a system account, then the certificate is typically in <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.LocalMachine" />. If the client application is running under a user account, then the certificate is typically in <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.CurrentUser" />.</para>
          <para>Values for <paramref name="storeName" /> are included in the <see cref="T:System.Security.Cryptography.X509Certificates.StoreName" /> enumeration.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Specifies the certificate to use for representing the service by specifying the subject distinguished name, the certificate store name and store location.</para>
        </summary>
        <param name="subjectName">
          <attribution license="cc4" from="Microsoft" modified="false" />Subject distinguished name.</param>
        <param name="storeLocation">
          <attribution license="cc4" from="Microsoft" modified="false" />The location of the certificate store the service uses to obtain the service certificate.</param>
        <param name="storeName">
          <attribution license="cc4" from="Microsoft" modified="false" />Specifies the name of the X.509 certificate store to open.</param>
      </Docs>
    </Member>
    <Member MemberName="SetCertificate">
      <MemberSignature Language="C#" Value="public void SetCertificate (System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, System.Security.Cryptography.X509Certificates.StoreName storeName, System.Security.Cryptography.X509Certificates.X509FindType findType, object findValue);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCertificate(valuetype System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, valuetype System.Security.Cryptography.X509Certificates.StoreName storeName, valuetype System.Security.Cryptography.X509Certificates.X509FindType findType, object findValue) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="storeLocation" Type="System.Security.Cryptography.X509Certificates.StoreLocation" />
        <Parameter Name="storeName" Type="System.Security.Cryptography.X509Certificates.StoreName" />
        <Parameter Name="findType" Type="System.Security.Cryptography.X509Certificates.X509FindType" />
        <Parameter Name="findValue" Type="System.Object" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Values for <paramref name="storeLocation" /> are included in the <see cref="T:System.Security.Cryptography.X509Certificates.StoreLocation" /> enumeration:</para>
          <list type="bullet">
            <item>
              <para>
                <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.LocalMachine" />: the certificate store assigned to the local machine (default).</para>
            </item>
            <item>
              <para>
                <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.CurrentUser" />: the certificate store used by the current user.</para>
            </item>
          </list>
          <para>If the client application is running under a system account, then the certificate is typically in <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.LocalMachine" />. If the client application is running under a user account, then the certificate is typically in <see cref="F:System.Security.Cryptography.X509Certificates.StoreLocation.CurrentUser" />.</para>
          <para>Values for <paramref name="storeName" /> are included in the <see cref="T:System.Security.Cryptography.X509Certificates.StoreName" /> enumeration.</para>
          <para>Values for <paramref name="findType" /> are included in the <see cref="T:System.Security.Cryptography.X509Certificates.X509FindType" /> enumeration.</para>
          <para>The most commonly used enumeration is <see cref="F:System.Security.Cryptography.X509Certificates.X509FindType.FindBySubjectName" />, which does a case-insensitive search on the subject name of certificates in the specified store. This can be an imprecise search. If more than one certificate is returned then the first one matching the find is used to represent the client.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Specifies the certificate to use for representing the service by specifying query parameters such as <paramref name="storeLocation" />, <paramref name="storeName" />, <paramref name="findType" /> and <paramref name="findValue" />.</para>
        </summary>
        <param name="storeLocation">
          <attribution license="cc4" from="Microsoft" modified="false" />The location of the certificate store the client uses to obtain the client certificate.</param>
        <param name="storeName">
          <attribution license="cc4" from="Microsoft" modified="false" />Specifies the name of the X.509 certificate store to open.</param>
        <param name="findType">
          <attribution license="cc4" from="Microsoft" modified="false" />Defines the type of X.509 search to be executed.</param>
        <param name="findValue">
          <attribution license="cc4" from="Microsoft" modified="false" />The value to search for in the X.509 certificate store.</param>
      </Docs>
    </Member>
  </Members>
</Type>