369 lines
23 KiB
XML
369 lines
23 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="NetworkCredential" FullName="System.Net.NetworkCredential" FullNameSP="System_Net_NetworkCredential" Maintainer="ecma">
|
|
<TypeSignature Language="ILASM" Value=".class public NetworkCredential extends System.Object implements System.Net.ICredentials" />
|
|
<TypeSignature Language="C#" Value="public class NetworkCredential : System.Net.ICredentials, System.Net.ICredentialsByHost" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NetworkCredential extends System.Object implements class System.Net.ICredentials, class System.Net.ICredentialsByHost" />
|
|
<MemberOfLibrary>Networking</MemberOfLibrary>
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.x.x</AssemblyVersion>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>System.Net.ICredentials</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.Net.ICredentialsByHost</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Net.NetworkCredential" /> class is a base class that supplies credentials in password-based authentication schemes such as basic, digest, NTLM, and Kerberos. Classes that implement the <see cref="T:System.Net.ICredentials" /> interface, such as the <see cref="T:System.Net.CredentialCache" /> class, return <see cref="T:System.Net.NetworkCredential" /> objects.</para>
|
|
<para>This class does not support public key-based authentication methods such as Secure Sockets Layer (SSL) client authentication.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides credentials for password-based authentication schemes such as basic, digest, NTLM, and Kerberos authentication.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor()" />
|
|
<MemberSignature Language="C#" Value="public NetworkCredential ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The default constructor for the <see cref="T:System.Net.NetworkCredential" /> class initializes all properties to null.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.NetworkCredential" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public NetworkCredential (string userName, System.Security.SecureString password);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string userName, class System.Security.SecureString password) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="userName" Type="System.String" />
|
|
<Parameter Name="password" Type="System.Security.SecureString" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The constructor initializes a <see cref="T:System.Net.NetworkCredential" /> object with the <see cref="P:System.Net.NetworkCredential.UserName" /> property set to <paramref name="userName" /> and the <see cref="P:System.Net.NetworkCredential.Password" /> property set to <paramref name="password" />.</para>
|
|
<para>The <paramref name="password" /> parameter is a <see cref="T:System.Security.SecureString" /> instance.</para>
|
|
<para>If this constructor is called with the <paramref name="password" /> parameter set to null, a new instance of <see cref="T:System.Security.SecureString" /> is initialized, If secure strings are not supported on this platform, then the <see cref="T:System.NotSupportedException" /> is thrown</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.NetworkCredential" /> class with the specified user name and password.</para>
|
|
</summary>
|
|
<param name="userName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the credentials.</param>
|
|
<param name="password">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The password for the user name associated with the credentials.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string userName, string password)" />
|
|
<MemberSignature Language="C#" Value="public NetworkCredential (string userName, string password);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string userName, string password) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="userName" Type="System.String" />
|
|
<Parameter Name="password" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The constructor initializes a <see cref="T:System.Net.NetworkCredential" /> object with the <see cref="P:System.Net.NetworkCredential.UserName" /> property set to <paramref name="userName" /> and the <see cref="P:System.Net.NetworkCredential.Password" /> property set to <paramref name="password" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.NetworkCredential" /> class with the specified user name and password.</para>
|
|
</summary>
|
|
<param name="userName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the credentials. </param>
|
|
<param name="password">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The password for the user name associated with the credentials. </param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public NetworkCredential (string userName, System.Security.SecureString password, string domain);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string userName, class System.Security.SecureString password, string domain) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="userName" Type="System.String" />
|
|
<Parameter Name="password" Type="System.Security.SecureString" />
|
|
<Parameter Name="domain" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The constructor initializes a <see cref="T:System.Net.NetworkCredential" /> object with the <see cref="P:System.Net.NetworkCredential.UserName" /> property set to <paramref name="userName" />, the <see cref="P:System.Net.NetworkCredential.Password" /> property set to <paramref name="password" />, and the <see cref="P:System.Net.NetworkCredential.Domain" /> property set to <paramref name="domain" />.</para>
|
|
<para>The <paramref name="password" /> parameter is a <see cref="T:System.Security.SecureString" /> instance.</para>
|
|
<para>If this constructor is called with the <paramref name="password" /> parameter set to null, a new instance of <see cref="T:System.Security.SecureString" /> is initialized, If secure strings are not supported on this platform, then the <see cref="T:System.NotSupportedException" /> is thrown</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.NetworkCredential" /> class with the specified user name, password, and domain.</para>
|
|
</summary>
|
|
<param name="userName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the credentials.</param>
|
|
<param name="password">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The password for the user name associated with the credentials.</param>
|
|
<param name="domain">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The domain associated with these credentials.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string userName, string password, string domain)" />
|
|
<MemberSignature Language="C#" Value="public NetworkCredential (string userName, string password, string domain);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string userName, string password, string domain) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="userName" Type="System.String" />
|
|
<Parameter Name="password" Type="System.String" />
|
|
<Parameter Name="domain" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The constructor initializes a <see cref="T:System.Net.NetworkCredential" /> object with the <see cref="P:System.Net.NetworkCredential.UserName" /> property set to <paramref name="userName" />, the <see cref="P:System.Net.NetworkCredential.Password" /> property set to <paramref name="password" />, and the <see cref="P:System.Net.NetworkCredential.Domain" /> property set to <paramref name="domain" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.NetworkCredential" /> class with the specified user name, password, and domain.</para>
|
|
</summary>
|
|
<param name="userName">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the credentials. </param>
|
|
<param name="password">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The password for the user name associated with the credentials. </param>
|
|
<param name="domain">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The domain associated with these credentials. </param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="Domain">
|
|
<MemberSignature Language="ILASM" Value=".property string Domain { public hidebysig specialname instance string get_Domain() public hidebysig specialname instance void set_Domain(string value) }" />
|
|
<MemberSignature Language="C#" Value="public string Domain { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Domain" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>
|
|
<para>A <see cref="T:System.String" /> containing the
|
|
name of the domain that verifies the current credentials.</para>
|
|
</value>
|
|
<permission cref="T:System.Security.Permissions.EnvironmentPermission">Requires read access to the environment variable that contains the domain name. See <see cref="F:System.Security.Permissions.EnvironmentPermissionAccess.Read" />.</permission>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Net.NetworkCredential.Domain" /> property specifies the domain or realm to which the user name belongs. Typically, this is the host computer name where the application runs or the user domain for the currently logged in user.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the domain or computer name that verifies the credentials.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="GetCredential">
|
|
<MemberSignature Language="ILASM" Value=".method public final hidebysig virtual class System.Net.NetworkCredential GetCredential(class System.Uri uri, string authType)" />
|
|
<MemberSignature Language="C#" Value="public System.Net.NetworkCredential GetCredential (Uri uri, string authType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Net.NetworkCredential GetCredential(class System.Uri uri, string authType) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.NetworkCredential</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="uri" Type="System.Uri" />
|
|
<Parameter Name="authType" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns an instance of the <see cref="T:System.Net.NetworkCredential" /> class for the specified Uniform Resource Identifier (URI) and authentication type.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <see cref="T:System.Net.NetworkCredential" /> object.</para>
|
|
</returns>
|
|
<param name="uri">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The URI that the client provides authentication for. </param>
|
|
<param name="authType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of authentication requested, as defined in the <see cref="P:System.Net.IAuthenticationModule.AuthenticationType" /> property. </param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="GetCredential">
|
|
<MemberSignature Language="C#" Value="public System.Net.NetworkCredential GetCredential (string host, int port, string authenticationType);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Net.NetworkCredential GetCredential(string host, int32 port, string authenticationType) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.NetworkCredential</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="host" Type="System.String" />
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
<Parameter Name="authenticationType" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The value of <paramref name="authType" /> corresponds to the <see cref="P:System.Net.IAuthenticationModule.AuthenticationType" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns an instance of the <see cref="T:System.Net.NetworkCredential" /> class for the specified host, port, and authentication type.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <see cref="T:System.Net.NetworkCredential" /> for the specified host, port, and authentication protocol, or null if there are no credentials available for the specified host, port, and authentication protocol.</para>
|
|
</returns>
|
|
<param name="host">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The host computer that authenticates the client.</param>
|
|
<param name="port">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The port on the <paramref name="host" /> that the client communicates with.</param>
|
|
<param name="authenticationType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type of authentication requested, as defined in the <see cref="P:System.Net.IAuthenticationModule.AuthenticationType" /> property. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Password">
|
|
<MemberSignature Language="ILASM" Value=".property string Password { public hidebysig specialname instance string get_Password() public hidebysig specialname instance void set_Password(string value) }" />
|
|
<MemberSignature Language="C#" Value="public string Password { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Password" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>
|
|
<para> A <see cref="T:System.String" /> containing the
|
|
password of the account associated with the current credentials.</para>
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<permission cref="T:System.Security.Permissions.SecurityPermission">Requires permission to execute unmanaged code. See <see cref="F:System.Security.Permissions.SecurityPermissionFlag.UnmanagedCode" />.</permission>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the password for the user name associated with the credentials.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="SecurePassword">
|
|
<MemberSignature Language="C#" Value="public System.Security.SecureString SecurePassword { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.SecureString SecurePassword" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Security.SecureString</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If an application attempts to set the <see cref="P:System.Net.NetworkCredential.SecurePassword" /> property to null, a new instance of <see cref="T:System.Security.SecureString" /> is initialized, If secure strings are not supported on this platform, then the <see cref="T:System.NotSupportedException" /> is thrown</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the password as a <see cref="T:System.Security.SecureString" /> instance.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="UserName">
|
|
<MemberSignature Language="ILASM" Value=".property string UserName { public hidebysig specialname instance string get_UserName() public hidebysig specialname instance void set_UserName(string value) }" />
|
|
<MemberSignature Language="C#" Value="public string UserName { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string UserName" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>
|
|
<para>A <see cref="T:System.String" /> containing the
|
|
user name for the account associated with the current credentials.</para>
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<permission cref="T:System.Security.Permissions.EnvironmentPermission">Requires read access to the environment variable that contains the user name. See <see cref="F:System.Security.Permissions.EnvironmentPermissionAccess.Read" />.</permission>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the user name associated with the credentials.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
</Members>
|
|
<TypeExcluded>0</TypeExcluded>
|
|
</Type> |