Partager via

REGSETVALUE

  • Article

5/10/2007

This command sets the data and type for any specified value or registry key. The data must be a text string.

Syntax

11, [ErrorMode], hKey, [ExpandMode], Key, [ExpandMode],
ValueName, Type, [Size,] Value

Parameters

  • ErrorMode
    Optional. Specified as a decimal representation of a hexadecimal bitmask. Values must be specified in decimal format. The following table shows the possible values.

    Value Name Description

    0 (0xnnnn0000)

    DAERH_ABORT

    Default. The abort-on-error mode stops the command file from processing further.

    32768 (0xnnnn8000)

    DAERH_IGNORE

    The ignore-on-error mode continues by processing the next command when an error occurs.

    32769-33023 (0x000080xx where xx!=00 is the number of retries)

    DAERH_RETRY_WITHIGNORE

    The retry-on-error with ignore mode retries the offending command up to 255 times. If the number of retries exceeds the retry count, this mode continues processing the next command.

    1-255(0x00xx where xx!=0 is the number of retries from 1-255)

    DAERH_RETRY_WITHABORT

    The retry-on-error with abort mode retries the offending command up to 255 times. If the number of retries exceeds the retry count, the command file processing halts.

    65536 – 4294901760(0xFFFFnnnn where FFFF is the delay mask in seconds)

    DAERH_DELAYMASK

    The delay error mode value is added to either the DAERH_RETRY_WITHIGNORE or the DAERH_RETRY_WITHABORT value to cause a delay between retries. This value is in seconds and has a range between 1 and 65535.

    Note

    Parsing errors, especially the passing of not valid command parameters, generates an error in DAERH_ABORT error mode. With logging enabled, an appropriate error message is output to the log file.

  • hKey
    Predefined registry handles. The following table shows the values for this parameter.

    Value Name

    2147483648

    HKEY_CLASSES_ROOT

    2147483649

    HKEY_CURRENT_USER

    2147483650

    HKEY_LOCAL_MACHINE

    2147483651

    HKEY_USERS

    2147483652

    HKEY_PERFORMANCE_DATA

    2147483653

    HKEY_CURRENT_CONFIG

  • ExpandMode
    Optional. Specifies if the string that follows it is an environment variable that should be expanded. Can occur multiple times with this command. The following table shows the possible values.

    Value Description

    0

    Does not expand the string.

    1

    Device Update Agent expands the string on the embedded device.

    2

    Device Update Agent script compiler expands the string on the developer computer.
  • Key
    String specifying the name of a key that this function opens or creates. This key must be a subkey of the key identified by the hKey parameter.

  • ValueName
    String containing the name of the value to set. If a value with this name is not already present in the key, the function adds it to the key.

    If ValueName is an empty string, "", the function sets the type and data for the unnamed or default value of the key.

    Registry keys do not have default values, but they can have one unnamed value, which can be of any type.

  • Type
    Specifies the type of information to be stored. For more information, see Registry Value Types.

  • Size
    Optional. Specifies the length, in bytes, of the string pointed to by the Data parameter, not including the terminating null character.

    Registry values of type binary need to be entered as an array of bytes. The Size parameter should specify the number of elements in the array. The binary data must be entered comma delimited with each element represented as a decimal value. The size value should be specified if Type is one of the following: DAREG_NONE, DAREG_BINARY, DAREG_LINK, DAREG_RESOURCE_LIST, and DAREG_MULTI_SZ. Do not use the Size parameter, if Type is not one of these values.

    For a DAREG_MULTI_SZ, Size should be the number of strings.

    Omit the Size parameter if Type is DAREG_SZ, DAREG_EXPAND_SZ, DAREG_DWORD, DAREG_DWORD_LITTLE_ENDIAN, DAREG_DWORD_BIG_ENDIAN, and DAREG_QWORD_LITTLE_ENDIAN.

  • Value
    String containing the data to set for the default value of the specified key.

Remarks

For more information, see the Microsoft Windows SDK documentation at this Microsoft Web site.

Example

The following example shows typical use.

//
// RegSetValue
//
REGSETVALUE,,HKEY_LOCAL_MACHINE,,SYSTEM\CurrentControlSet\SampleKey,,SampleValue,DAREG_SZ,Hello World

See Also

Concepts

DUA Script Command Reference