Função DsGetIcon (dsclient.h)

Artigo
08/23/2023

A função DsGetIcon obtém o ícone de uma determinada classe de objeto. Essa função está obsoleta. Novos aplicativos devem usar o método IDsDisplaySpecifier::GetIcon para executar essa função.

Sintaxe

HICON DsGetIcon(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszObjectClass,
  [in] INT     cxImage,
  [in] INT     cyImage
);

Parâmetros

[in] dwFlags

Contém um conjunto de sinalizadores que indicam o tipo de ícone a ser recuperado. Isso pode ser uma combinação de um ou mais dos valores a seguir.

DSGIF_ISNORMAL

Obtém o ícone normal para a classe de objeto.

DSGIF_ISOPEN

Obtém o ícone aberto, como uma pasta aberta, para a classe de objeto . Se a classe de objeto não tiver um ícone aberto, essa função tentará obter o ícone normal para a classe de objeto.

DSGIF_ISDISABLED

Obtém o ícone desabilitado, como um usuário desabilitado, para a classe de objeto . Se a classe de objeto não tiver um ícone desabilitado, essa função tentará obter o ícone normal para a classe de objeto.

DSGIF_GETDEFAULTICON

Se nenhum ícone puder ser encontrado para a classe de objeto, essa função retornará um ícone padrão. Se esse sinalizador não for especificado e nenhum ícone puder ser encontrado para a classe de objeto, essa função retornará NULL.

DSGIF_DEFAULTISCONTAINER

Se nenhum ícone puder ser encontrado para a classe de objeto, essa função retornará o ícone de contêiner como o ícone padrão. Se esse sinalizador não for especificado e nenhum ícone puder ser encontrado para a classe de objeto, essa função retornará NULL.

[in] pszObjectClass

Ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém o nome da classe de objeto para a qual recuperar o ícone. Exemplos do nome da classe de objeto são "user" e "container".

[in] cxImage

Contém a largura desejada, em pixels, do ícone. Essa função recupera o ícone que mais corresponde a essa largura.

[in] cyImage

Contém a altura desejada, em pixels, do ícone. Essa função recupera o ícone que mais corresponde a essa altura.

Retornar valor

Retorna um identificador para o ícone se tiver êxito ou NULL caso contrário. O chamador deve destruir esse ícone quando ele não for mais necessário passando esse identificador para DestroyIcon.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	dsclient.h
Biblioteca	Dsuiext.lib
DLL	Dsuiext.dll

Confira também

Destroyicon

IDsDisplaySpecifier::GetIcon

Compartilhar via