Método IDesktopWallpaper::GetWallpaper (shobjidl_core.h)

Artigo
08/26/2023

Obtém o papel de parede da área de trabalho atual.

Sintaxe

HRESULT GetWallpaper(
  [in]  LPCWSTR monitorID,
  [out] LPWSTR  *wallpaper
);

Parâmetros

[in] monitorID

A ID do monitor. Esse valor pode ser obtido por meio de GetMonitorDevicePathAt.

Esse valor pode ser definido como NULL. Nesse caso, se uma única imagem de papel de parede for exibida em todos os monitores do sistema, o método retornará com êxito. Se esse valor for definido como NULL e monitores diferentes estiverem exibindo papéis de parede diferentes ou uma apresentação de slides estiver em execução, o método retornará S_FALSE e uma cadeia de caracteres vazia no parâmetro de papel de parede .

[out] wallpaper

O endereço de um ponteiro para um buffer que, quando esse método retorna com êxito, recebe o caminho para o arquivo de imagem de papel de parede. Observe que essa imagem pode ser exibida atualmente em todos os monitores do sistema, não apenas no monitor especificado no parâmetro monitorID .

Essa cadeia de caracteres ficará vazia se nenhuma imagem de papel de parede estiver sendo exibida ou se um monitor estiver exibindo uma cor sólida. A cadeia de caracteres também estará vazia se o método falhar.

Retornar valor

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

Requisitos


Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shobjidl_core.h (inclua Shobjidl.h)

Confira também

IDesktopWallpaper

IDesktopWallpaper::SetWallpaper

Share via