Método IUserNotification2::SetBalloonInfo (shobjidl.h)

Define as informações a serem exibidas em uma notificação de balão.

Sintaxe

HRESULT SetBalloonInfo(
  [in] LPCWSTR pszTitle,
  [in] LPCWSTR pszText,
  [in] DWORD   dwInfoFlags
);

Parâmetros

[in] pszTitle

Tipo: LPCWSTR

Um ponteiro para uma cadeia de caracteres Unicode que especifica o título da notificação.

[in] pszText

Tipo: LPCWSTR

Um ponteiro para uma cadeia de caracteres Unicode que especifica o texto a ser exibido no corpo do balão.

[in] dwInfoFlags

Tipo: DWORD

Um ou mais dos valores a seguir que indicam um ícone a ser exibido no balão de notificação.

NIIF_NONE (0x00000000)

0x00000000. Não exiba um ícone.

NIIF_INFO (0x00000001)

0x00000001. Exibir um ícone de informações.

NIIF_WARNING (0x00000002)

0x00000002. Exibir um ícone de aviso.

NIIF_ERROR (0x00000003)

0x00000003. Exibir um ícone de erro.

NIIF_USER (0x00000004)

0x00000004. Windows XP SP2 e posterior. Use o ícone identificado no hIcon no balão de notificação.

NIIF_NOSOUND (0x00000010)

0x00000010. Windows XP e posterior. Não reproduza o som associado. Esse valor se aplica apenas a notificações de balão e não a notificações de usuário padrão.

NIIF_LARGE_ICON (0x00000010)

0x00000010. Windows Vista e posteriores. A versão grande do ícone deve ser usada como o ícone no balão de notificação. Isso corresponde ao ícone com dimensões SM_CXICON x SM_CYICON. Se esse sinalizador não estiver definido, o ícone com dimensões XM_CXSMICON x SM_CYSMICON será usado.

• Esse sinalizador pode ser usado com todos os ícones de estoque.
• Os aplicativos que usam ícones personalizados mais antigos (NIIF_USER com hIcon) devem fornecer uma nova versão SM_CXICON x SM_CYICON no ícone de bandeja especificado no membro hIcon da estrutura NOTIFYICONDATA . Esses ícones são reduzidos horizontalmente quando são exibidos na área de notificação.
• Novos ícones personalizados (NIIF_USER com hBalloonIcon) devem fornecer uma versão SM_CXICON x SM_CYICON no ícone fornecido (hBalloonIcon).

NIIF_RESPECT_QUIET_TIME (0x00000080)

0x00000080. Windows 7 e posterior. Não exiba o balão de notificação se o usuário atual estiver em "tempo de silêncio", que é a primeira hora após um novo usuário fazer logon em sua conta pela primeira vez. Durante esse tempo, a maioria das notificações não deve ser enviada ou mostrada. Isso permite que um usuário se acostume com um novo sistema de computador sem essas distrações. O tempo de silêncio também ocorre para cada usuário após uma atualização do sistema operacional ou limpo instalação. Uma notificação enviada com esse sinalizador durante o tempo de silêncio não está na fila; ele é simplesmente ignorado desacompartada. O aplicativo poderá reenviar a notificação posteriormente se ela ainda for válida nesse momento.

Como um aplicativo não pode prever quando pode encontrar um tempo tranquilo, recomendamos que esse sinalizador sempre seja definido em todas as notificações apropriadas por qualquer aplicativo que signifique respeitar o tempo de silêncio.

Se o usuário atual não estiver em tempo de silêncio, esse sinalizador não terá efeito.

NIIF_ICON_MASK (0x0000000F)

0x0000000F. Windows XP (Shell32.dll versão 6.0) e posterior. Reservado.

Retornar valor

Tipo: HRESULT

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shobjidl.h

Confira também

IUserNotification2

SetBalloonInfo