Função SHGetSpecialFolderPathA (shlobj_core.h)

Artigo
11/20/2024

[ SHGetSpecialFolderPath não tem suporte. Em vez disso, use SHGetFolderPath.]

Recupera o caminho de uma pasta especial, identificada por seu CSIDL.

Sintaxe

BOOL SHGetSpecialFolderPathA(
        HWND  hwnd,
  [out] LPSTR pszPath,
  [in]  int   csidl,
  [in]  BOOL  fCreate
);

Parâmetros

hwnd

Tipo: HWND

Reservado.

[out] pszPath

Tipo: LPTSTR

Um ponteiro para uma cadeia de caracteres terminada em nulo que recebe a unidade e o caminho da pasta especificada. Esse buffer deve ter pelo menos MAX_PATH caracteres de tamanho.

[in] csidl

Tipo: int

Um CSIDL que identifica a pasta de interesse. Se uma pasta virtual for especificada, essa função falhará.

[in] fCreate

Tipo: BOOL

Indica se a pasta deve ser criada se ela ainda não existir. Se esse valor não for zero, a pasta será criada. Se esse valor for zero, a pasta não será criada.

Valor de retorno

Tipo: BOOL

verdadeiro se bem-sucedido; caso contrário, FALSE .

Observações

A Atualização da Área de Trabalho do Microsoft Internet Explorer 4.0 deve estar instalada para que essa função esteja disponível.

Nota

O cabeçalho shlobj_core.h define SHGetSpecialFolderPath 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	shlobj_core.h (inclua Shlobj.h, Shlobj_core.h)
biblioteca	Shell32.lib
de DLL	Shell32.dll (versão 4.71 ou posterior)

Compartilhar via