Share via

Método IShellIconOverlayIdentifier::GetOverlayInfo (shobjidl_core.h)

  • Artigo

Fornece o local do bitmap da sobreposição do ícone.

Sintaxe

HRESULT GetOverlayInfo(
  [out] LPWSTR pwszIconFile,
        int    cchMax,
  [out] int    *pIndex,
  [out] DWORD  *pdwFlags
);

Parâmetros

[out] pwszIconFile

Tipo: PWSTR

Uma cadeia de caracteres Unicode terminada em nulo que contém o caminho totalmente qualificado do arquivo que contém o ícone. Os tipos de arquivo .dll, .exe e .ico são aceitáveis. Você deve definir o sinalizador ISIOI_ICONFILE em pdwFlags se retornar um nome de arquivo.

cchMax

Tipo: int

O tamanho do buffer pwszIconFile , em caracteres Unicode.

[out] pIndex

Tipo: int*

Ponteiro para um valor de índice usado para identificar o ícone em um arquivo que contém vários ícones. Você deve definir o sinalizador ISIOI_ICONINDEX em pdwFlags se retornar um índice.

[out] pdwFlags

Tipo: DWORD*

Ponteiro para um bitmap que especifica as informações que estão sendo retornadas pelo método . Esse parâmetro pode ser um ou ambos os valores a seguir.

ISIOI_ICONFILE (0x00000001)

O caminho do arquivo de ícone é retornado por meio de pwszIconFile.

ISIOI_ICONINDEX (0x00000002)

Há mais de um ícone em pwszIconFile. O índice do ícone é retornado por meio de pIndex.

Valor retornado

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Esse método é chamado pelo Shell na inicialização para que a sobreposição de ícone do manipulador possa ser adicionada à lista de imagens do sistema. Após a conclusão da inicialização, o Shell chama GetOverlayInfo quando precisa exibir a sobreposição de ícone do manipulador.

Nota Depois que a imagem tiver sido carregada na lista de imagens do sistema durante a inicialização, ela não poderá ser alterada. Após a inicialização, o nome do arquivo e o índice são usados apenas para identificar a sobreposição do ícone. O sistema não carregará uma nova sobreposição de ícone. Quando GetOverlayInfo é chamado, seu manipulador deve retornar o mesmo nome de arquivo e índice especificados quando a função foi chamada pela primeira vez.
 

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shobjidl_core.h (inclua Shlobj.h)
DLL Shell32.dll (versão 5.0 ou posterior)