SetStringValue method of the StdRegProv Class

Applies to: desktop apps only

The SetStringValue method sets the data value for a named value whose data type is REG_SZ.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

uint32 SetStringValue(
  [in]  uint32 hDefKey = HKEY_LOCAL_MACHINE,
  [in]  string sSubKeyName,
  [in]  string sValueName,
  [in]  string sValue
);

Parameters

hDefKey [in]

A registry tree, also known as a hive, that contains the sSubKeyName path. The default value is HKEY_LOCAL_MACHINE.

Note that HKEY_DYN_DATA is a valid tree for computers running Windows 95 and Windows 98 only.

The following trees are defined in Winreg.h.

HKEY_CLASSES_ROOT (2147483648 (0x80000000))

HKEY_CURRENT_USER (2147483649 (0x80000001))

HKEY_LOCAL_MACHINE (2147483650 (0x80000002))

HKEY_USERS (2147483651 (0x80000003))

HKEY_CURRENT_CONFIG (2147483653 (0x80000005))

HKEY_DYN_DATA (2147483654 (0x80000006))

sSubKeyName [in]

A key that contains the named value to be set.

sValueName [in]

A named value whose data value you are setting. You can specify an existing named value (update) or a new named value (create). Specify an empty string to set the data value for the default named value.

sValue [in]

A data value.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository. Other examples are in books and articles listed in Further Information.

For C++ code examples, see WMI C++ Application Examples.

The following VBScript code example shows how to call the SetStringValue method to write a string value to a key. The script first creates the key.

const HKEY_LOCAL_MACHINE = &H80000002
strComputer = "."
Set objReg=GetObject("winmgmts:{impersonationLevel=impersonate}!\\"&_ 
    strComputer & "\root\default:StdRegProv")

strKeyPath = "SOFTWARE\MyKey\"
KeyPath = "Software\MyKey"
strValueName = "String Value Name"
strValue = "string value"

' Create key to use
Return = objReg.CreateKey(HKEY_LOCAL_MACHINE, KeyPath)
If (Return = 0) And (Err.Number = 0) Then   
    Wscript.Echo "HKEY_LOCAL_MACHINE\Software\MyKey created"

    ' write string value to key    
    Return = objReg.SetStringValue( _
        HKEY_LOCAL_MACHINE,strKeyPath,strValueName,strValue)
    If (Return = 0) And (Err.Number = 0) Then 
        Wscript.Echo "HKEY_LOCAL_MACHINE\Software\MyKey" & _ 
            " contains 'string value'"
    Else
        Wscript.Echo "SetStringValue failed. Error = " & Err.Number
    End If
Else
    Wscript.Echo "CreateKey failed. Error = " & Err.Number
End If

Requirements

See also

StdRegProv

Modifying the System Registry

WMI Tasks: Registry

Send comments about this topic to Microsoft

Build date: 3/9/2012