RegistryKey.GetSubKeyNames Method (Microsoft.Win32)

.NET Framework Class Library

RegistryKey..::.GetSubKeyNames Method

Retrieves an array of strings that contains all the subkey names.

Namespace: Microsoft.Win32
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

Public Function GetSubKeyNames As String()

Visual Basic (Usage)

Dim instance As RegistryKey
Dim returnValue As String()

returnValue = instance.GetSubKeyNames()

public string[] GetSubKeyNames()

Visual C++

public:
array<String^>^ GetSubKeyNames()

JScript

public function GetSubKeyNames() : String[]

Return Value

Type: array<System..::.String>[]()[]
An array of strings that contains the names of the subkeys for the current key.

Exceptions

Exception	Condition
SecurityException	The user does not have the permissions required to read from the key.
ObjectDisposedException	The RegistryKey being manipulated is closed (closed keys cannot be accessed).
UnauthorizedAccessException	The user does not have the necessary registry rights.
IOException	A system error occurred, for example the current key has been deleted.

Remarks

This method does not recursively find names. It returns the names on the base level from which it was called.

Examples

This code example is part of a larger example provided for the RegistryKey class.

Visual Basic

' Print the information from the Test9999 subkey.
Console.WriteLine("There are {0} subkeys under Test9999.", _
    test9999.SubKeyCount.ToString())
For Each subKeyName As String In test9999.GetSubKeyNames()
    Dim tempKey As RegistryKey = _
        test9999.OpenSubKey(subKeyName)
    Console.WriteLine(vbCrLf & "There are {0} values for " & _
        "{1}.", tempKey.ValueCount.ToString(), tempKey.Name)
    For Each valueName As String In tempKey.GetValueNames()
        Console.WriteLine("{0,-8}: {1}", valueName, _
            tempKey.GetValue(valueName).ToString())
    Next
Next

// Print the information from the Test9999 subkey.
Console.WriteLine("There are {0} subkeys under {1}.", 
    test9999.SubKeyCount.ToString(), test9999.Name);
foreach(string subKeyName in test9999.GetSubKeyNames())
{
    using(RegistryKey 
        tempKey = test9999.OpenSubKey(subKeyName))
    {
        Console.WriteLine("\nThere are {0} values for {1}.", 
            tempKey.ValueCount.ToString(), tempKey.Name);
        foreach(string valueName in tempKey.GetValueNames())
        {
            Console.WriteLine("{0,-8}: {1}", valueName, 
                tempKey.GetValue(valueName).ToString());
        }
    }
}

Visual C++

// Print the information from the Test9999 subkey.
Console::WriteLine( "There are {0} subkeys under Test9999.", test9999->SubKeyCount.ToString() );
array<String^>^subKeyNames = test9999->GetSubKeyNames();
for ( int i = 0; i < subKeyNames->Length; i++ )
{
   RegistryKey ^ tempKey = test9999->OpenSubKey( subKeyNames[ i ] );
   Console::WriteLine( "\nThere are {0} values for {1}.", tempKey->ValueCount.ToString(), tempKey->Name );
   array<String^>^valueNames = tempKey->GetValueNames();
   for ( int j = 0; j < valueNames->Length; j++ )
   {
      Console::WriteLine( "{0,-8}: {1}", valueNames[ j ], tempKey->GetValue( valueNames[ j ] )->ToString() );

   }
}

.NET Framework Security

RegistryPermission
for the ability to read from the registry. Associated enumeration: RegistryPermissionAccess..::.Read

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0

Reference

RegistryKey Class

RegistryKey Members

Microsoft.Win32 Namespace

SubKeyCount

GetValueNames