Função GetAllUsersProfileDirectoryA (userenv.h)

Artigo
11/20/2024

Recupera o caminho para a raiz do diretório que contém dados do programa compartilhados por todos os usuários.

Sintaxe

USERENVAPI BOOL GetAllUsersProfileDirectoryA(
  [out, optional] LPSTR   lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Parâmetros

[out, optional] lpProfileDir

Tipo: LPTSTR

Um ponteiro para um buffer que, quando essa função retorna com êxito, recebe o caminho. Defina esse valor como NULL para determinar o tamanho necessário do buffer, incluindo o caractere nulo de encerramento.

[in, out] lpcchSize

Tipo: LPDWORD

Um ponteiro para o tamanho do buffer lpProfileDir , em TCHARs.

Se o buffer especificado por lpProfileDir não for grande o suficiente ou lpProfileDir for NULL, a função falhará e esse parâmetro receberá o tamanho do buffer necessário, incluindo o caractere nulo de encerramento.

Valor de retorno

Tipo: BOOL

verdadeiro se bem-sucedido; caso contrário, FALSE . Para obter informações de erro estendidas, chame GetLastError.

Observações

Veja a seguir um exemplo do caminho retornado por GetAllUsersProfileDirectory no Windows XP:

C:\Documents and Settings\All Users

Veja a seguir um exemplo do caminho retornado por GetAllUsersProfileDirectory no Windows 7:

C:\ProgramData

Para obter os caminhos dos subdiretórios desse diretório, use a SHGetFolderPath (Windows XP e anterior) ou função shGetKnownFolderPath (Windows Vista).

Nota

O cabeçalho userenv.h define GetAllUsersProfileDirectory 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 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	userenv.h
biblioteca	Userenv.lib
de DLL	Userenv.dll

Consulte também

GetDefaultUserProfileDirectory

GetProfilesDirectory

GetUserProfileDirectory

Visão geral dos perfis de usuário

Referência de perfis de usuário

Compartilhar via