Admin Production ni-theme
Current Publication

RegWriteString

LabWindows/CVI

RegWriteString

int RegWriteString (unsigned int rootKey, const char subkeyName[], const char valueName[], const unsigned char stringBuffer[]);

Purpose

This function writes a NUL–terminated ASCII string to the specified Key Value in the Windows Registry. You must specify a Root Key, a Subkey of that Root Key, and the actual Value of that Subkey to which you want to write the data.

Example:

RegWriteString (REGKEY_HKLM, "Software\\MySubKey", "MyStringValue", "This is a string buffer");

(Linux) This function is not supported.

Parameters

Input
Name Type Description
rootKey unsigned int The Root Key under which you wish to access a Subkey and its value.

See the Windows Registry functions Class help for more information about Root Keys.
subkeyName const char[] The name of the Subkey, relative to the Root Key, to which you want to write value data.

See the Windows Registry functions Class help for more information about Subkeys.
valueName const char[] The name of the value to which you want to write data. If the value name does not exist this function will create it.

You may pass NULL or an empty string to write to the Key's Default Value.

See the Windows Registry functions Class help for more information about Key Values.
stringBuffer const unsigned char[] The NUL–terminated ASCII string you wish to write to the specified Value of the specified Subkey.

Return Value

Name Type Description
status int The status code that the function returns.

0 indicates success.

A negative value indicates an error.

This function may return a Programmer's Toolbox or UI Library error code. Call GetGeneralErrorString to obtain a text description of the error.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later