Méthode IUserNotification ::SetBalloonInfo (shobjidl_core.h)

Article
03/02/2024

Définit les informations à afficher dans une notification de bulle.

Syntaxe

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

Paramètres

[in] pszTitle

Type : LPCWSTR

Pointeur vers une chaîne Unicode qui spécifie le titre de la notification.

[in] pszText

Type : LPCWSTR

Pointeur vers une chaîne Unicode qui spécifie le texte à afficher dans le corps de la bulle.

[in] dwInfoFlags

Type : DWORD

Une ou plusieurs des valeurs suivantes qui indiquent une icône à afficher dans la bulle de notification.

NIIF_NONE (0x00000000)

0x00000000. N’affichez pas d’icône.

NIIF_INFO (0x00000001)

0x00000001. Afficher une icône d’informations.

NIIF_WARNING (0x00000002)

0x00000002. Afficher une icône d’avertissement.

NIIF_ERROR (0x00000003)

0x00000003. Afficher une icône d’erreur.

NIIF_USER (0x00000004)

0x00000004. Windows XP SP2 et versions ultérieures. Utilisez l’icône identifiée dans hIcon dans la bulle de notification.

NIIF_NOSOUND (0x00000010)

0x00000010. Windows XP et versions ultérieures. Ne lisez pas le son associé. Cette valeur s’applique uniquement aux notifications de bulle et non aux notifications utilisateur standard.

NIIF_LARGE_ICON (0x00000010)

0x00000010. Windows Vista et versions ultérieures. La version volumineuse de l’icône doit être utilisée comme icône dans la bulle de notification. Cela correspond à l’icône avec des dimensions SM_CXICON x SM_CYICON. Si cet indicateur n’est pas défini, l’icône avec des dimensions XM_CXSMICON x SM_CYSMICON est utilisée.

Cet indicateur peut être utilisé avec toutes les icônes de stock.
Les applications qui utilisent des icônes personnalisées plus anciennes (NIIF_USER avec hIcon) doivent fournir une nouvelle version SM_CXICON x SM_CYICON dans l’icône de barre d’état spécifiée dans le membre hIcon de la structure NOTIFYICONDATA . Ces icônes sont mises à l’échelle quand elles sont affichées dans la zone de notification.
Les nouvelles icônes personnalisées (NIIF_USER avec hBalloonIcon) doivent fournir une version SM_CXICON x SM_CYICON dans l’icône fournie (hBalloonIcon).

NIIF_RESPECT_QUIET_TIME (0x00000080)

0x00000080. Windows 7 et versions ultérieures. N’affichez pas la bulle de notification si l’utilisateur actuel est en « temps calme », c’est-à-dire la première heure après qu’un nouvel utilisateur se connecte à son compte pour la première fois. Pendant ce temps, la plupart des notifications ne doivent pas être envoyées ou affichées. Cela permet à un utilisateur de s’habituer à un nouveau système informatique sans ces distractions. Le temps de silence se produit également pour chaque utilisateur après une mise à niveau ou propre installation du système d’exploitation. Une notification envoyée avec cet indicateur pendant le temps d’attente n’est pas mise en file d’attente ; il est tout simplement ignoré sans montrer. L’application peut renvoyer la notification ultérieurement si elle est toujours valide à ce moment-là.

Étant donné qu’une application ne peut pas prédire quand elle peut rencontrer une heure de silence, nous recommandons que cet indicateur soit toujours défini sur toutes les notifications appropriées par toute application qui signifie respecter le temps de silence.

Si l’utilisateur actuel n’est pas en temps calme, cet indicateur n’a aucun effet.

NIIF_ICON_MASK (0x0000000F)

0x0000000F. Windows XP (Shell32.dll version 6.0) et ultérieures. Réservé.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shobjidl_core.h (incluez Shobjidl.h)

Partager via