Job Management Partner 1/Software Distribution Automatic Installation Tool Description and Reference

[Contents][Glossary][Index][Back][Next]

AIT_RegGetStringValue

Description

Acquires a registry value of the character string data type (REG_SZ, REG_EXPAND_SZ, or REG_MULTI_SZ).

Format

bool AIT_RegGetStringValue(
  integer nHKeyHandle,      // Key handle
  string strRegKeyName,     // Registry sub-key name
  string strRegValueName,   // Registry value name
  string strRegValueData    // Registry value data
);

Parameters

nHKeyHandle (input)

Specify a handle to an already opened registry key, or one of the following values.

strRegKeyName (input)

Specify a registry sub-key name.

strRegValueName (input)

Specify a registry value name you want to acquire.

strRegValueData (output)

Specify a variable to receive registry value data of the character string data type. When the function returns, the variable stores the registry data value.

Return values

The return value is true if the function was executed normally, and false if not. If the function has returned false, you can use AIT_GetLastError to acquire an extended error code. The following gives the error codes that AIT_GetLastError may return.

Extended error number Error code
2 ERROR_FILE_NOT_FOUND
6 ERROR_INVALID_HANDLE
87 ERROR_INVALID_PARAMETER
234 ERROR_MORE_DATA
1009 ERROR_BADDB
1010 ERROR_BADKEY
1011 ERROR_CANTOPEN
1012 ERROR_CANTREAD
1015 ERROR_REGISTRY_CORRUPT
1016 ERROR_REGISTRY_IO_FAILED
1018 ERROR_KEY_DELETED
1019 ERROR_NO_LOG_SPACE
1169 ERROR_NO_MATCH