Função RegLoadMUIStringA (winreg.h)

Artigo
11/20/2024

Carrega a cadeia de caracteres especificada da chave e da subchave especificadas.

Sintaxe

LSTATUS RegLoadMUIStringA(
  [in]            HKEY    hKey,
  [in, optional]  LPCSTR  pszValue,
  [out, optional] LPSTR   pszOutBuf,
  [in]            DWORD   cbOutBuf,
  [out, optional] LPDWORD pcbData,
  [in]            DWORD   Flags,
  [in, optional]  LPCSTR  pszDirectory
);

Parâmetros

[in] hKey

Um identificador para uma chave aberta do Registro. A chave deve ter sido aberta com o acesso KEY_QUERY_VALUE direito. Para obter mais informações, consulte de Direitos de Acesso e Segurança de Chave do Registro.

Esse identificador é retornado pela função RegCreateKeyEx ou RegOpenKeyEx. Também pode ser uma das seguintes chaves predefinidas :

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_USERS

[in, optional] pszValue

O nome do valor do registro.

[out, optional] pszOutBuf

Um ponteiro para um buffer que recebe a cadeia de caracteres.

As cadeias de caracteres do formulário a seguir recebem tratamento especial:

@[caminho]\dllname,-strID

A cadeia de caracteres com identificador strID é carregada de dllname; o caminho é opcional. Se o parâmetro pszDirectory não for NULL, o diretório será anexado ao caminho especificado nos dados do Registro. Observe que dllname pode conter variáveis de ambiente a serem expandidas.

[in] cbOutBuf

O tamanho do buffer de pszOutBuf , em bytes.

[out, optional] pcbData

Um ponteiro para uma variável que recebe o tamanho dos dados copiados para o buffer de pszOutBuf , em bytes.

Se o buffer não for grande o suficiente para armazenar 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 é indefinido.

[in] Flags

Esse parâmetro pode ser 0 ou o valor a seguir.

Valor	Significado
REG_MUI_STRING_TRUNCATE 0x00000001	A cadeia de caracteres é truncada para se ajustar ao tamanho disponível do buffer de pszOutBuf . Se esse sinalizador for especificado, pcbData deverá ser NULL.

[in, optional] pszDirectory

O caminho do diretório.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS.

Se a função falhar, o valor retornado será um código de erro do sistema.

Se o pcbData buffer for muito pequeno para receber a cadeia de caracteres, a função retornará ERROR_MORE_DATA.

A versão ANSI dessa função retorna ERROR_CALL_NOT_IMPLEMENTED.

Observações

A função RegLoadMUIString tem suporte apenas para Unicode. Embora as versões Unicode (W) e ANSI (A) dessa função sejam declaradas, a função RegLoadMUIStringA retorna ERROR_CALL_NOT_IMPLEMENTED. Os aplicativos devem chamar explicitamente RegLoadMUIStringW ou especificar Unicode como o conjunto de caracteres nas chamadas PInvoke (invocação de plataforma).

Para compilar um aplicativo que usa essa função, defina _WIN32_WINNT como 0x0600 ou posterior. Para obter mais informações, consulte Usando os cabeçalhos do Windows.

Nota

O cabeçalho winreg.h define RegLoadMUIString como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows Vista [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2008 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	winreg.h (inclua Windows.h)
biblioteca	Advapi32.lib
de DLL	Advapi32.dll

Consulte também

Funções do Registro

Compartilhar via