0 out of 1 rated this helpful - Rate this topic

RegistryValueOptions Enumeration

.NET Framework 2.0

Other Versions

Note: This enumeration is new in the .NET Framework version 2.0.

Specifies optional behavior when retrieving name/value pairs from a registry key.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

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

Syntax

C++

[FlagsAttribute] 
public enum RegistryValueOptions

/** @attribute FlagsAttribute() */ 
public enum RegistryValueOptions

JScript

FlagsAttribute 
public enum RegistryValueOptions

Members

	Member name	Description
	DoNotExpandEnvironmentNames	A value of type RegistryValueKind.ExpandString is retrieved without expanding its embedded environment variables.
	None	No optional behavior is specified.

Remarks

Use the DoNotExpandEnvironmentNames flag with the RegistryKey.GetValue(String,Object,RegistryValueOptions) method overload.

Example

The following code sample creates a test key, adds a value with an embedded environment variable, and retrieves the value in both expanded and unexpanded forms.

C++

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

import System.*;
import Microsoft.Win32.*;
import Microsoft.VisualBasic.*;

public class Example
{
    public static void main(String args[])
    {
        // 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

Platforms

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0

Reference

Microsoft.Win32 Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD