Environment.UserDomainName Property (System)

UserDomainName Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Environment..::.UserDomainName Property

Gets the network domain name associated with the current user.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic

Public Shared ReadOnly Property UserDomainName As String

public static string UserDomainName { get; }

Visual C++

public:
static property String^ UserDomainName {
    String^ get ();
}

static member UserDomainName : string

Property Value

Type: System..::.String
The network domain name associated with the current user.

Exceptions

Exception	Condition
PlatformNotSupportedException	The operating system does not support retrieving the network domain name.
InvalidOperationException	The network domain name cannot be retrieved.

Remarks

The domain account credentials for a user are formatted as the user's domain name, the '\' character, and user name. Use the UserDomainName property to obtain the user's domain name and the UserName property to obtain the user name. A user name is typically an abbreviated combination of the user's first and last names.

The UserDomainName property first attempts to get the domain name component of the Windows account name for the current user. If that attempt fails, this property attempts to get the domain name associated with the user name provided by the UserName property. If that attempt fails because the host computer is not joined to a domain, then the host computer name is returned.

Windows 95, Windows 98, Windows 98 Second Edition, Windows Millennium Edition Platform Note: The UserDomainName property is not supported for this platform.

Examples

The following example displays the user domain name of the computer that runs the code example. (The user domain name is omitted from the example output for security reasons.)

Visual Basic

' Sample for the Environment.UserDomainName property
Imports System

Class Sample
   Public Shared Sub Main()
      Console.WriteLine()
      '  <-- Keep this information secure! -->
      Console.WriteLine("UserDomainName: {0}", Environment.UserDomainName)
   End Sub 'Main
End Class 'Sample
'
'This example produces the following results:
'(Any result that is lengthy, specific to the machine on which this sample was tested, 
'or reveals information that should remain secure, has been omitted 
'and marked "!---OMITTED---!".)
'
'UserDomainName: !---OMITTED---!
'

// Sample for the Environment.UserDomainName property
using System;

class Sample 
{
    public static void Main() 
    {
    Console.WriteLine();
//  <-- Keep this information secure! -->
    Console.WriteLine("UserDomainName: {0}", Environment.UserDomainName);
    }
}
/*
This example produces the following results:
(Any result that is lengthy, specific to the machine on which this sample was tested, or reveals information that should remain secure, has been omitted and marked "!---OMITTED---!".)

UserDomainName: !---OMITTED---!
*/

Visual C++

// Sample for the Environment::UserDomainName property
using namespace System;
int main()
{
   Console::WriteLine();

   //  <-- Keep this information secure! -->
   Console::WriteLine( "UserDomainName: {0}", Environment::UserDomainName );
}

/*
This example produces the following results:
(Any result that is lengthy, specific to the machine on which this sample was tested, or reveals information that should remain secure, has been omitted and marked S"!---OMITTED---!".)

UserDomainName: !---OMITTED---!
*/

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

EnvironmentPermission
for read access to the USERDOMAIN environment variable. Associated enumeration: EnvironmentPermissionAccess..::.Read

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Environment Class

System Namespace

UserName