CALL "REG_QUERY_VALUE_EX" USING openKey valueName type data dataSize GIVING returnCode |
openKey | USAGE UNSIGNED-LONG | Specifies the handle to an open registry key. The calling process must have KEY_QUERY_VALUE access to the key. This handle is returned by the REG_CREATE_KEY, REG_CREATE_KEY_EX, REG_OPEN_KEY or REG_OPEN_KEY_EX library routine, or it can be one of the following predefined keys, defined in isreg.def: HKEY_CLASSES_ROOT HKEY_CURRENT_CONFIG HKEY_CURRENT_USER HKEY_LOCAL_MACHINE HKEY_USERS HKEY_DYN_DATA | |
valueName | PIC X(n) | Specifies the name of the registry value. If valueName is NULL or an empty string, "", the function retrieves the type and data for the key's unnamed or default value, if any. | |
type | USAGE UNSIGNED-LONG | It receives a code indicating the type of data stored in the specified value. It can be one of the following values, defined in isreg.def: | |
REG_BINARY | Binary data in any form. | ||
REG_DWORD | A 32-bit number. | ||
REG_DWORD_LITTLE_ENDIAN | A 32-bit number in little-endian format. | ||
REG_DWORD_BIG_ENDIAN | A 32-bit number in big-endian format. | ||
REG_EXPAND_SZ | A null-terminated string that contains unexpanded references to environment variables (for example, "%PATH%"). | ||
REG_LINK | Reserved for system use. | ||
REG_MULTI_SZ | A sequence of null-terminated strings. The following is an example: | ||
String1\0String2\0String3\0LastString\0\0 | |||
The first \0 terminates the first string, the second to the last \0 terminates the last string, and the final \0 terminates the sequence. Note that the final terminator must be factored into the length of the string. | |||
REG_NONE | No defined value type. | ||
REG_QWORD | A 64-bit number. | ||
REG_QWORD_LITTLE_ENDIAN | A 64-bit number in little-endian format. | ||
REG_SZ | A string. | ||
data | PIC X(n) | Receives the data for the value entry. This parameter can be NULL if the data is not required. | |
dataSize | USAGE UNSIGNED-LONG | Specifies the size of the data parameter, in bytes. When the function returns, this variable contains the size of the data copied to data. The dataSize parameter can be NULL only if data is NULL. If the data has the REG_SZ, REG_MULTI_SZ or REG_EXPAND_SZ type, this size includes any terminating null character or characters. If the data parameter is not large enough to hold the data, the function returns ERROR_MORE_DATA and stores the required buffer size in the dataSize. In this case, the contents of data are undefined. If data is NULL, and dataSize is non-NULL, the function returns ERROR_SUCCESS and stores the size of the data, in bytes, in dataSize. This enables an application to determine the best way to allocate a buffer for the value's data. If openKey specifies HKEY_PERFORMANCE_DATA and dataSize is not large enough to contain all of the returned data, REG_QUERY_VALUE_EX returns ERROR_MORE_DATA and the value returned through the dataSize parameter is undefined. This is because the size of the performance data can change from one call to the next. In this case, you must increase the buffer size and call REG_QUERY_VALUE_EX again passing the updated buffer size in the dataSize parameter. Repeat this until the function succeeds. You need to maintain a separate variable to keep track of the buffer size, because the value returned by dataSize is unpredictable. | |
-1 | Invalid or missing parameters, or not running on Windows |
0 | Operation successful. |
Non zero | Operation failed. Click here for a list of error codes. |
working-storage section. copy "isreg.def". 01 subkey-handle usage unsigned-long. 77 status-code pic 9(3). 77 value-name pic x(20). 77 value-data pic x(50). 77 data-size usage unsigned-long. ... procedure division. ... query-value. move "iscobol-value" to value-name set data-size to size of value-data call "reg_query_value_ex" using subkey-handle value-name data-type value-data data-size giving status-code. |