RegReadULong
int RegReadULong (unsigned int rootKey, const char subkeyName[], const char valueName[], unsigned long *ULongData, int dataFormat);
Purpose
This function reads unsigned 32–bit (unsigned long) data from 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 which you want to read.
Example:
unsigned long number;
// Reads the data in MyULongValue in Little–Endian format
RegReadULong (REGKEY_HKLM, "Software\\MySubKey",
"MyULongValue", &number, 0);
(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), from which you wish to read value data. See the Windows Registry functions Class help for more information about Subkeys. |
| valueName | const char[] | The name of the Value from which you want to read data. See the Windows Registry functions Class help for more information about Key Values. |
| dataFormat | int | Determines how the 32–bit integer is stored in the Registry. Typically, you specify Little Endian (Intel) format. Specify a nonzero value or select Big Endian in the function panel to use Big Endian format. Specify 0 or select Little Endian in the function panel to use Little Endian format. |
| Output | ||
| Name | Type | Description |
| ULongData | unsigned long | Returns the unsigned long contents of 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