Função ORGetValue
Recupera o tipo e os dados do valor do Registro especificado em um hive de registro offline.
DWORD ORGetValue(
_In_ ORHKEY Handle,
_In_opt_ PCWSTR lpSubKey,
_In_opt_ PCWSTR lpValue,
_Out_opt_ PDWORD pdwType,
_Out_opt_ PVOID pvData,
_Inout_opt_ PDWORD pcbData
);
-
Manipular [in]
-
Um identificador para uma chave do Registro aberta em um hive de registro offline.
-
lpSubKey [in, opcional]
-
O nome da chave do Registro. Essa chave deve ser uma subchave da chave especificada pelo parâmetro Handle . Este parâmetro pode ser NULL.
Os nomes de chave não diferenciam maiúsculas de minúsculas.
-
lpValue [in, opcional]
-
O nome do valor do Registro. Se esse parâmetro for NULL ou uma cadeia de caracteres vazia, "", a função recuperará o tipo e os dados do valor não nomeado ou padrão da chave, se houver. Para obter mais informações, consulte Limites de tamanho do elemento do Registro.
As chaves não têm automaticamente um valor não nomeado ou padrão. Valores sem nome podem ser de qualquer tipo.
Os nomes de valor não diferenciam maiúsculas de minúsculas.
-
pdwType [out, opcional]
-
Um ponteiro para uma variável que recebe um código que indica o tipo de dados armazenados no valor especificado. Para obter uma lista dos códigos de tipo possíveis, consulte Tipos de valor do Registro. Esse parâmetro poderá ser NULL se o tipo não for necessário.
-
pvData [out, opcional]
-
Um ponteiro para um buffer que recebe os dados do valor. Esse parâmetro poderá ser NULL se os dados não forem necessários.
Se os dados forem uma cadeia de caracteres, a função verificará se há um caractere nulo de terminação. Se um não for encontrado, a cadeia de caracteres será armazenada com um terminador nulo se o buffer for grande o suficiente para acomodar o caractere extra. Caso contrário, a função falhará e retornará ERROR_MORE_DATA.
-
pcbData [entrada, saída, opcional]
-
Um ponteiro para uma variável que especifica o tamanho do buffer apontado pelo parâmetro pvData , em bytes. Quando a função retorna, essa variável contém o tamanho dos dados copiados para pvData.
O parâmetro pcbData só poderá ser NULL se pvData for NULL.
Se os dados tiverem o tipo REG_SZ, REG_MULTI_SZ ou REG_EXPAND_SZ, esse tamanho incluirá caracteres ou caracteres nulos de terminação. Para obter mais informações, consulte Comentários.
Se o buffer especificado pelo parâmetro pvData não for grande o suficiente para manter os dados, a função retornará ERROR_MORE_DATA e armazenará o tamanho do buffer necessário na variável apontada por pcbData. Nesse caso, o conteúdo do buffer pvData é indefinido.
Se pvData for NULL e pcbData não for NULL, a função retornará ERROR_SUCCESS e armazenará o tamanho dos dados, em bytes, na variável apontada por pcbData. Isso permite que um aplicativo determine a melhor maneira de alocar um buffer para os dados do valor.
Se a função obtiver êxito, o valor retornado será ERROR_SUCCESS.
Se a função falhar, o valor de retorno será o código de erro diferente de zero definido em Winerror.h. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para obter uma descrição genérica do erro.
Um aplicativo normalmente chama a função OREnumValue para determinar os nomes de valor e, em seguida, chama a função ORGetValue para recuperar os dados dos nomes.
| Requisito | Valor |
|---|---|
| Redistribuível |
Biblioteca do Registro Offline do Windows versão 1.0 ou posterior |
| Cabeçalho |
|
| DLL |
|