RegistryKey.GetValue Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Извлекает значение, связанное с указанным именем.
Перегрузки
| Имя | Описание |
|---|---|
| GetValue(String, Object, RegistryValueOptions) |
Извлекает значение, связанное с указанным именем и параметрами извлечения. Если имя не найдено, возвращает указанное значение по умолчанию. |
| GetValue(String) |
Извлекает значение, связанное с указанным именем. Возвращает, |
| GetValue(String, Object) |
Извлекает значение, связанное с указанным именем. Если имя не найдено, возвращает указанное значение по умолчанию. |
GetValue(String, Object, RegistryValueOptions)
- Исходный код:
- RegistryKey.cs
Извлекает значение, связанное с указанным именем и параметрами извлечения. Если имя не найдено, возвращает указанное значение по умолчанию.
public:
System::Object ^ GetValue(System::String ^ name, System::Object ^ defaultValue, Microsoft::Win32::RegistryValueOptions options);
public object? GetValue(string? name, object? defaultValue, Microsoft.Win32.RegistryValueOptions options);
public object GetValue(string name, object defaultValue, Microsoft.Win32.RegistryValueOptions options);
[System.Runtime.InteropServices.ComVisible(false)]
public object GetValue(string name, object defaultValue, Microsoft.Win32.RegistryValueOptions options);
member this.GetValue : string * obj * Microsoft.Win32.RegistryValueOptions -> obj
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.GetValue : string * obj * Microsoft.Win32.RegistryValueOptions -> obj
Public Function GetValue (name As String, defaultValue As Object, options As RegistryValueOptions) As Object
Параметры
- name
- String
Имя извлекаемого значения. Эта строка не учитывает регистр.
- defaultValue
- Object
Значение, возвращаемое, если name не существует.
- options
- RegistryValueOptions
Одно из значений перечисления, указывающее необязательную обработку полученного значения.
Возвращаемое значение
Значение, связанное с , обработанное в соответствии с nameуказанным optionsили defaultValue если name оно не найдено.
- Атрибуты
Исключения
У пользователя нет разрешений, необходимых для чтения из раздела реестра.
Значение RegistryKey , содержащее указанное значение, закрывается (закрытые ключи не могут быть доступны).
Значение RegistryKey , содержащее указанное значение, помечается для удаления.
options не является допустимым RegistryValueOptions значением. Например, недопустимое значение приведение к RegistryValueOptions.
У пользователя нет необходимых прав реестра.
Примеры
В следующем примере кода создается тестовый ключ, добавляется значение со встроенной переменной среды и извлекается значение как в развернутых, так и необъясненных формах.
#using <Microsoft.VisualBasic.dll>
using namespace System;
using namespace Microsoft::Win32;
using namespace Microsoft::VisualBasic;
int main()
{
// Delete and recreate the test key.
Registry::CurrentUser->DeleteSubKey( L"RegistryValueOptionsExample", false );
RegistryKey ^ rk =
Registry::CurrentUser->CreateSubKey( L"RegistryValueOptionsExample" );
// Add a value that contains an environment variable.
rk->SetValue( L"ExpandValue", L"The path is %PATH%",
RegistryValueKind::ExpandString );
// Retrieve the value, first without expanding the environment
// variable and then expanding it.
Console::WriteLine( L"Unexpanded: \"{0}\"",
rk->GetValue( L"ExpandValue",
L"No Value",
RegistryValueOptions::DoNotExpandEnvironmentNames ) );
Console::WriteLine( L"Expanded: \"{0}\"", rk->GetValue( L"ExpandValue" ) );
return 0;
} //Main
using System;
using Microsoft.Win32;
using Microsoft.VisualBasic;
public class Example
{
public static void Main()
{
// Delete and recreate the test key.
Registry.CurrentUser.DeleteSubKey("RegistryValueOptionsExample", false);
RegistryKey rk =
Registry.CurrentUser.CreateSubKey("RegistryValueOptionsExample");
// Add a value that contains an environment variable.
rk.SetValue("ExpandValue", "The path is %PATH%", RegistryValueKind.ExpandString);
// Retrieve the value, first without expanding the environment
// variable and then expanding it.
Console.WriteLine("Unexpanded: \"{0}\"",
rk.GetValue("ExpandValue", "No Value",
RegistryValueOptions.DoNotExpandEnvironmentNames));
Console.WriteLine("Expanded: \"{0}\"", rk.GetValue("ExpandValue"));
} //Main
} //Example
Imports Microsoft.Win32
Public Class Example
Public Shared Sub Main()
' Delete and recreate the test key.
Registry.CurrentUser.DeleteSubKey("RegistryValueOptionsExample", False)
Dim rk As RegistryKey = _
Registry.CurrentUser.CreateSubKey("RegistryValueOptionsExample")
' Add a value that contains an environment variable.
rk.SetValue("ExpandValue", "The path is %PATH%", _
RegistryValueKind.ExpandString)
' Retrieve the value, first without expanding the environment
' variable and then expanding it.
Console.WriteLine("Unexpanded: ""{0}""", _
rk.GetValue("ExpandValue", "No Value", _
RegistryValueOptions.DoNotExpandEnvironmentNames))
Console.WriteLine("Expanded: ""{0}""", rk.GetValue("ExpandValue"))
End Sub
End Class
Комментарии
Используйте эту перегрузку, чтобы указать специальную обработку полученного значения. Например, можно указать RegistryValueOptions.DoNotExpandEnvironmentNames при получении значения реестра типа RegistryValueKind.ExpandString , чтобы получить строку без расширения внедренных переменных среды.
defaultValue Используйте параметр, чтобы указать значение, возвращаемое, если name оно не существует.
Note
Раздел реестра может иметь одно значение, которое не связано с каким-либо именем. Если это неназваемое значение отображается в редакторе реестра, строка "(По умолчанию)" отображается вместо имени. Чтобы получить это неназваемое значение, укажите null или пустую строку ("") для name.
GetValue не поддерживает чтение значений типа REG_NONE или REG_LINK. В обоих случаях значение по умолчанию возвращаетсяnull вместо фактического значения.
См. также раздел
Применяется к
GetValue(String)
- Исходный код:
- RegistryKey.cs
Извлекает значение, связанное с указанным именем. Возвращает, null если пара name/value не существует в реестре.
public:
System::Object ^ GetValue(System::String ^ name);
public object? GetValue(string? name);
public object GetValue(string name);
member this.GetValue : string -> obj
Public Function GetValue (name As String) As Object
Параметры
- name
- String
Имя извлекаемого значения. Эта строка не учитывает регистр.
Возвращаемое значение
Значение, связанное с nameили null если name оно не найдено.
Исключения
У пользователя нет разрешений, необходимых для чтения из раздела реестра.
Значение RegistryKey , содержащее указанное значение, закрывается (закрытые ключи не могут быть доступны).
Значение RegistryKey , содержащее указанное значение, помечается для удаления.
У пользователя нет необходимых прав реестра.
Примеры
В следующем примере кода создается тестовый ключ и добавляются значения различных типов данных в ключ. Затем в примере считываются пары "имя-значение" и отображаются в консоли с помощью GetValueKind метода для получения соответствующих типов данных реестра.
using namespace System;
using namespace Microsoft::Win32;
int main()
{
// Delete and recreate the test key.
Registry::CurrentUser->DeleteSubKey( "RegistryValueKindExample", false );
RegistryKey ^ rk = Registry::CurrentUser->CreateSubKey( "RegistryValueKindExample" );
// Create name/value pairs.
// This overload supports QWord (long) values.
rk->SetValue( "QuadWordValue", 42, RegistryValueKind::QWord );
// The following SetValue calls have the same effect as using the
// SetValue overload that does not specify RegistryValueKind.
//
rk->SetValue( "DWordValue", 42, RegistryValueKind::DWord );
rk->SetValue( "MultipleStringValue", gcnew array<String^>{
"One","Two","Three"
}, RegistryValueKind::MultiString );
rk->SetValue( "BinaryValue", gcnew array<Byte>{
10,43,44,45,14,255
}, RegistryValueKind::Binary );
rk->SetValue( "StringValue", "The path is %PATH%", RegistryValueKind::String );
// This overload supports setting expandable string values. Compare
// the output from this value with the previous string value.
rk->SetValue( "ExpandedStringValue", "The path is %PATH%", RegistryValueKind::ExpandString );
// Display all the name/value pairs stored in the test key, with the
// registry data type in parentheses.
//
array<String^>^valueNames = rk->GetValueNames();
System::Collections::IEnumerator^ myEnum = valueNames->GetEnumerator();
while ( myEnum->MoveNext() )
{
String^ s = safe_cast<String^>(myEnum->Current);
RegistryValueKind rvk = rk->GetValueKind( s );
switch ( rvk )
{
case RegistryValueKind::MultiString:
{
array<String^>^values = (array<String^>^)rk->GetValue( s );
Console::Write( "\r\n {0} ({1}) =", s, rvk );
for ( int i = 0; i < values->Length; i++ )
{
if (i != 0) Console::Write(",");
Console::Write( " \"{0}\"", values[ i ] );
}
Console::WriteLine();
break;
}
case RegistryValueKind::Binary:
{
array<Byte>^bytes = (array<Byte>^)rk->GetValue( s );
Console::Write( "\r\n {0} ({1}) =", s, rvk );
for ( int i = 0; i < bytes->Length; i++ )
{
// Display each byte as two hexadecimal digits.
Console::Write( " {0:X2}", bytes[ i ] );
}
Console::WriteLine();
break;
}
default:
Console::WriteLine( "\r\n {0} ({1}) = {2}", s, rvk, rk->GetValue( s ) );
break;
}
}
}
/*
This code example produces the following output:
QuadWordValue (QWord) = 42
DWordValue (DWord) = 42
MultipleStringValue (MultiString) =, "One", "Two", "Three"
BinaryValue (Binary) = 0A 2B 2C 2D 0E FF
StringValue (String) = The path is %PATH%
ExpandedStringValue (ExpandString) = The path is C:\Program Files\Microsoft.NET\SDK\v2.0\Bin;
[***The remainder of this output is omitted.***]
*/
using System;
using Microsoft.Win32;
public class Example
{
public static void Main()
{
// Delete and recreate the test key.
Registry.CurrentUser.DeleteSubKey("RegistryValueKindExample", false);
RegistryKey rk = Registry.CurrentUser.CreateSubKey("RegistryValueKindExample");
// Create name/value pairs.
// This overload supports QWord (long) values.
rk.SetValue("QuadWordValue", 42, RegistryValueKind.QWord);
// The following SetValue calls have the same effect as using the
// SetValue overload that does not specify RegistryValueKind.
//
rk.SetValue("DWordValue", 42, RegistryValueKind.DWord);
rk.SetValue("MultipleStringValue", new string[] {"One", "Two", "Three"}, RegistryValueKind.MultiString);
rk.SetValue("BinaryValue", new byte[] {10, 43, 44, 45, 14, 255}, RegistryValueKind.Binary);
rk.SetValue("StringValue", "The path is %PATH%", RegistryValueKind.String);
// This overload supports setting expandable string values. Compare
// the output from this value with the previous string value.
rk.SetValue("ExpandedStringValue", "The path is %PATH%", RegistryValueKind.ExpandString);
// Display all name/value pairs stored in the test key, with each
// registry data type in parentheses.
//
string[] valueNames = rk.GetValueNames();
foreach (string s in valueNames)
{
RegistryValueKind rvk = rk.GetValueKind(s);
switch (rvk)
{
case RegistryValueKind.MultiString :
string[] values = (string[]) rk.GetValue(s);
Console.Write("\r\n {0} ({1}) =", s, rvk);
for (int i = 0; i < values.Length; i++)
{
if (i != 0) Console.Write(",");
Console.Write(" \"{0}\"", values[i]);
}
Console.WriteLine();
break;
case RegistryValueKind.Binary :
byte[] bytes = (byte[]) rk.GetValue(s);
Console.Write("\r\n {0} ({1}) =", s, rvk);
for (int i = 0; i < bytes.Length; i++)
{
// Display each byte as two hexadecimal digits.
Console.Write(" {0:X2}", bytes[i]);
}
Console.WriteLine();
break;
default :
Console.WriteLine("\r\n {0} ({1}) = {2}", s, rvk, rk.GetValue(s));
break;
}
}
}
}
/*
This code example produces the following output:
QuadWordValue (QWord) = 42
DWordValue (DWord) = 42
MultipleStringValue (MultiString) =, "One", "Two", "Three"
BinaryValue (Binary) = 0A 2B 2C 2D 0E FF
StringValue (String) = The path is %PATH%
ExpandedStringValue (ExpandString) = The path is C:\Program Files\Microsoft.NET\SDK\v2.0\Bin;
[***The remainder of this output is omitted.***]
*/
Imports Microsoft.Win32
Public Class Example
Public Shared Sub Main()
' Delete and recreate the test key.
Registry.CurrentUser.DeleteSubKey("RegistryValueKindExample", False)
Dim rk As RegistryKey = Registry.CurrentUser.CreateSubKey("RegistryValueKindExample")
' Create name/value pairs.
' This overload supports QWord (long) values.
rk.SetValue("QuadWordValue", 42, RegistryValueKind.QWord)
' The following SetValue calls have the same effect as using the
' SetValue overload that does not specify RegistryValueKind.
'
rk.SetValue("DWordValue", 42, RegistryValueKind.DWord)
rk.SetValue("MultipleStringValue", New String() {"One", "Two", "Three"}, RegistryValueKind.MultiString)
rk.SetValue("BinaryValue", New Byte() {10, 43, 44, 45, 14, 255}, RegistryValueKind.Binary)
rk.SetValue("StringValue", "The path is %PATH%", RegistryValueKind.String)
' This overload supports setting expandable string values. Compare
' the output from this value with the previous string value.
rk.SetValue("ExpandedStringValue", "The path is %PATH%", RegistryValueKind.ExpandString)
' Display all name/value pairs stored in the test key, with each
' registry data type in parentheses.
'
Dim valueNames As String() = rk.GetValueNames()
Dim s As String
For Each s In valueNames
Dim rvk As RegistryValueKind = rk.GetValueKind(s)
Select Case rvk
Case RegistryValueKind.MultiString
Dim values As String() = CType(rk.GetValue(s), String())
Console.Write(vbCrLf & " {0} ({1}) =", s, rvk)
For i As Integer = 0 To values.Length - 1
If i <> 0 Then Console.Write(",")
Console.Write(" ""{0}""", values(i))
Next i
Console.WriteLine()
Case RegistryValueKind.Binary
Dim bytes As Byte() = CType(rk.GetValue(s), Byte())
Console.Write(vbCrLf & " {0} ({1}) =", s, rvk)
For i As Integer = 0 To bytes.Length - 1
' Display each byte as two hexadecimal digits.
Console.Write(" {0:X2}", bytes(i))
Next i
Console.WriteLine()
Case Else
Console.WriteLine(vbCrLf & " {0} ({1}) = {2}", s, rvk, rk.GetValue(s))
End Select
Next s
End Sub
End Class
'
'This code example produces the following output (some output is omitted):
'
' QuadWordValue (QWord) = 42
'
' DWordValue (DWord) = 42
'
' MultipleStringValue (MultiString) = "One", "Two", "Three"
'
' BinaryValue (Binary) = 0A 2B 2C 2D 0E FF
'
' StringValue (String) = The path is %PATH%
'
' ExpandedStringValue (ExpandString) = The path is C:\Program Files\Microsoft.NET\SDK\v2.0\Bin;
' [***The remainder of this output is omitted.***]
Комментарии
Note
Раздел реестра может иметь одно значение, которое не связано с каким-либо именем. Если это неназваемое значение отображается в редакторе реестра, строка "(По умолчанию)" отображается вместо имени. Чтобы получить это неназваемое значение, укажите null или пустую строку ("") для name.
GetValue Когда метод получает расширяемые строковые значения (RegistryValueKind.ExpandString), он расширяет строки среды с помощью данных из локальной среды. Чтобы получить расширяемые строковые значения из реестра на удаленном компьютере, используйте GetValue(String, Object, RegistryValueOptions) перегрузку метода, чтобы указать, что строки среды не развернуты.
Note
Если значение, содержащее развернутые ссылки на переменные среды, хранится как строка (RegistryValueKind.String), а не как расширяемая строка (RegistryValueKind.ExpandString), GetValue не развертывает ее. После получения такой строки можно развернуть, вызвав ExpandEnvironmentVariables метод.
Note
Рекомендуемый способ получения данных из PerformanceData ключа — использовать PerformanceCounter класс, а не RegistryKey.GetValue метод.
GetValue не поддерживает чтение значений типа REG_NONE или REG_LINK. В обоих случаях значение по умолчанию возвращаетсяnull вместо фактического значения.
См. также раздел
Применяется к
GetValue(String, Object)
- Исходный код:
- RegistryKey.cs
Извлекает значение, связанное с указанным именем. Если имя не найдено, возвращает указанное значение по умолчанию.
public:
System::Object ^ GetValue(System::String ^ name, System::Object ^ defaultValue);
public object? GetValue(string? name, object? defaultValue);
public object GetValue(string name, object defaultValue);
member this.GetValue : string * obj -> obj
Public Function GetValue (name As String, defaultValue As Object) As Object
Параметры
- name
- String
Имя извлекаемого значения. Эта строка не учитывает регистр.
- defaultValue
- Object
Значение, возвращаемое, если name не существует.
Возвращаемое значение
Значение, связанное с nameпеременными внедренной среды, остается нераспределенным или defaultValue если name оно не найдено.
Исключения
У пользователя нет разрешений, необходимых для чтения из раздела реестра.
Значение RegistryKey , содержащее указанное значение, закрывается (закрытые ключи не могут быть доступны).
Значение RegistryKey , содержащее указанное значение, помечается для удаления.
У пользователя нет необходимых прав реестра.
Примеры
В следующем примере кода создается тестовый ключ со значением и извлекается это значение. Затем этот пример пытается получить несуществующее значение из ключа; В этом случае GetValue метод возвращает указанное значение по умолчанию.
using namespace System;
using namespace Microsoft::Win32;
public ref class RegGetDef
{
public:
static void Main()
{
// Create a reference to a valid key. In order for this code to
// work, the indicated key must have been created previously.
// The key name is not case-sensitive.
RegistryKey^ rk = Registry::LocalMachine->OpenSubKey("Software\\myTestKey", false);
// Get the value from the specified name/value pair in the key.
String^ valueName = "myTestValue";
Console::WriteLine("Retrieving registry value ...");
Console::WriteLine();
Object^ o = rk->GetValue(valueName);
Console::WriteLine("Object Type = " + o->GetType()->FullName);
Console::WriteLine();
switch (rk->GetValueKind(valueName))
{
case RegistryValueKind::String:
case RegistryValueKind::ExpandString:
Console::WriteLine("Value = " + o);
break;
case RegistryValueKind::Binary:
for each (Byte^ b in (array<Byte^>^)o)
{
Console::Write("{0:x2} ", b);
}
Console::WriteLine();
break;
case RegistryValueKind::DWord:
Console::WriteLine("Value = " + Convert::ToString((Int32^)o));
break;
case RegistryValueKind::QWord:
Console::WriteLine("Value = " + Convert::ToString((Int64^)o));
break;
case RegistryValueKind::MultiString:
for each (String^ s in (array<String^>^)o)
{
Console::Write("[{0:s}], ", s);
}
Console::WriteLine();
break;
default:
Console::WriteLine("Value = (Unknown)");
break;
}
// Attempt to retrieve a value that does not exist; the specified
// default value is returned.
String^ def = (String^)rk->GetValue("notavalue", "The default to return");
Console::WriteLine();
Console::WriteLine(def);
rk->Close();
}
};
int main()
{
RegGetDef::Main();
}
/*
Output:
Retrieving registry value ...
Object Type = System.String
Value = testData
The default to return
*/
using System;
using Microsoft.Win32;
class RegGetDef
{
public static void Main()
{
// Create a reference to a valid key. In order for this code to
// work, the indicated key must have been created previously.
// The key name is not case-sensitive.
RegistryKey rk = Registry.LocalMachine.OpenSubKey("Software\\myTestKey", false);
// Get the value from the specified name/value pair in the key.
string valueName = "myTestValue";
Console.WriteLine("Retrieving registry value ...");
Console.WriteLine();
object o = rk.GetValue(valueName);
Console.WriteLine("Object Type = " + o.GetType().FullName);
Console.WriteLine();
switch (rk.GetValueKind(valueName))
{
case RegistryValueKind.String:
case RegistryValueKind.ExpandString:
Console.WriteLine("Value = " + o);
break;
case RegistryValueKind.Binary:
foreach (byte b in (byte[])o)
{
Console.Write("{0:x2} ", b);
}
Console.WriteLine();
break;
case RegistryValueKind.DWord:
Console.WriteLine("Value = " + Convert.ToString((int)o));
break;
case RegistryValueKind.QWord:
Console.WriteLine("Value = " + Convert.ToString((Int64)o));
break;
case RegistryValueKind.MultiString:
foreach (string s in (string[])o)
{
Console.Write("[{0:s}], ", s);
}
Console.WriteLine();
break;
default:
Console.WriteLine("Value = (Unknown)");
break;
}
// Attempt to retrieve a value that does not exist; the specified
// default value is returned.
string def = (string)rk.GetValue("notavalue", "The default to return");
Console.WriteLine();
Console.WriteLine(def);
rk.Close();
}
}
/*
Output:
Retrieving registry value ...
Object Type = System.String
Value = testData
The default to return
*/
Imports Microsoft.Win32
Public Class RegGetDef
Public Shared Sub Main()
' Create a reference to a valid key. In order for this code to
' work, the indicated key must have been created previously.
' The key name is not case-sensitive.
Dim rk As RegistryKey = Registry.LocalMachine.OpenSubKey("Software\myTestKey", false)
' Get the value from the specified name/value pair in the key.
Dim valueName As String = "myTestValue"
Console.WriteLine("Retrieving registry value ...")
Console.WriteLine()
Dim o As Object = rk.GetValue(valueName)
Console.WriteLine("Object Type = " + o.GetType().FullName)
Console.WriteLine()
Select Case rk.GetValueKind(valueName)
Case RegistryValueKind.String
Case RegistryValueKind.ExpandString
Console.WriteLine("Value = " + o)
Case RegistryValueKind.Binary
For Each b As Byte In CType(o,Byte())
Console.Write("{0:x2} ", b)
Next b
Console.WriteLine()
Case RegistryValueKind.DWord
Console.WriteLine("Value = " + Convert.ToString(CType(o,Int32)))
Case RegistryValueKind.QWord
Console.WriteLine("Value = " + Convert.ToString(CType(o,Int64)))
Case RegistryValueKind.MultiString
For Each s As String In CType(o,String())
Console.Write("[{0:s}], ", s)
Next s
Console.WriteLine()
Case Else
Console.WriteLine("Value = (Unknown)")
End Select
' Attempt to retrieve a value that does not exist; the specified
' default value is returned.
Dim Def As String = rk.GetValue("notavalue", "The default to return")
Console.WriteLine()
Console.WriteLine(def)
rk.Close()
End Sub
End Class
'
' Output:
' Retrieving registry value ...
'
' Object Type = System.String
'
' Value = testData
'
'The default to return
Комментарии
Используйте эту перегрузку для обработки ситуации GetValue , когда имя еще не существует, например при первом запуске приложения. При вызове этой перегрузки используйте defaultValue параметр, чтобы указать возвращаемое значение, если name оно не существует.
Note
Раздел реестра может иметь одно значение, которое не связано с каким-либо именем. Если это неназваемое значение отображается в редакторе реестра, строка "(По умолчанию)" отображается вместо имени. Чтобы получить это неназваемое значение, укажите null или пустую строку ("") для name.
GetValue Когда метод получает расширяемые строковые значения (RegistryValueKind.ExpandString), он расширяет строки среды с помощью данных из локальной среды. Чтобы получить расширяемые строковые значения из реестра на удаленном компьютере, используйте GetValue перегрузку, чтобы указать, что строки среды не развернуты.
Note
Если значение, содержащее развернутые ссылки на переменные среды, хранится как строка (RegistryValueKind.String), а не как расширяемая строка (RegistryValueKind.ExpandString), GetValue метод не расширяет его. После получения такой строки можно развернуть, вызвав ExpandEnvironmentVariables метод.
Note
Рекомендуемый способ получения данных из PerformanceData ключа — использовать PerformanceCounter класс, а не RegistryKey.GetValue метод.
GetValue не поддерживает чтение значений типа REG_NONE или REG_LINK. В обоих случаях значение по умолчанию возвращаетсяnull вместо фактического значения.