Função GetEnvironmentVariable (winbase.h)

Recupera o conteúdo da variável especificada do bloco de ambiente do processo de chamada.

Sintaxe

DWORD GetEnvironmentVariable(
  [in, optional]  LPCTSTR lpName,
  [out, optional] LPTSTR  lpBuffer,
  [in]            DWORD   nSize
);

Parâmetros

[in, optional] lpName

O nome da variável de ambiente.

[out, optional] lpBuffer

Um ponteiro para um buffer que recebe o conteúdo da variável de ambiente especificada como uma cadeia de caracteres terminada em nulo. Uma variável de ambiente tem um limite de tamanho máximo de 32.767 caracteres, incluindo o caractere de terminação nula.

[in] nSize

O tamanho do buffer apontado pelo parâmetro lpBuffer , incluindo o caractere de terminação nula, em caracteres.

Retornar valor

Se a função for bem-sucedida, o valor retornado será o número de caracteres armazenados no buffer apontado por lpBuffer, sem incluir o caractere nulo de terminação.

Se lpBuffer não for grande o suficiente para manter os dados, o valor retornado será o tamanho do buffer, em caracteres, necessário para manter a cadeia de caracteres e seu caractere nulo de terminação e o conteúdo de lpBuffer são indefinidos.

Se a função falhar, o valor retornado será zero. Se a variável de ambiente especificada não tiver sido encontrada no bloco de ambiente, GetLastError retornará ERROR_ENVVAR_NOT_FOUND.

Comentários

Essa função pode recuperar uma variável de ambiente do sistema ou uma variável de ambiente do usuário.

Exemplos

Para obter um exemplo, consulte Alterando variáveis de ambiente.

Requisitos

Confira também

Variáveis de ambiente

GetEnvironmentStrings

Setenvironmentvariable