Partager via

Fonction SHGetUnreadMailCountA (shellapi.h)

  • Article

Récupère le nombre de messages non lus d’un utilisateur spécifié pour tout ou partie des comptes de messagerie.

Syntaxe

HRESULT SHGetUnreadMailCountA(
  [in, optional]  HKEY     hKeyUser,
  [in, optional]  LPCSTR   pszMailAddress,
  [out, optional] DWORD    *pdwCount,
  [out, optional] FILETIME *pFileTime,
  [out, optional] LPSTR    pszShellExecuteCommand,
                  int      cchShellExecuteCommand
);

Paramètres

[in, optional] hKeyUser

Type : HKEY

HKEY valide pour un utilisateur donné. Ce paramètre doit avoir la valeur NULL si la fonction est appelée dans l’environnement d’un utilisateur, auquel cas HKEY_CURRENT_USER est utilisé. Ce paramètre doit avoir la valeur NULL si la fonction est appelée à partir du contexte SYSTEM, auquel cas HKEY_USERS\{SID} est utilisé.

[in, optional] pszMailAddress

Type : LPCTSTR

Pointeur vers une chaîne en Unicode qui spécifie l’adresse e-mail d’un compte appartenant à l’utilisateur spécifié. Lorsque ce paramètre a la valeur NULL, pdwCount retourne le nombre total de messages non lus pour tous les comptes appartenant à l’utilisateur désigné.

[out, optional] pdwCount

Type : DWORD*

Pointeur vers une valeur DWORD qui reçoit le nombre de messages non lus.

[out, optional] pFileTime

Type : FILETIME*

Pointeur vers une structure FILETIME . L’utilisation de ce paramètre est déterminée par la valeur NULLde pszMailAddress. Si pszMailAddress a la valeur NULL, ce paramètre est traité comme un paramètre [in], qui spécifie un filtre, de sorte que seul le courrier non lu plus récent que l’heure spécifiée s’affiche. Si pszMailAddress n’a pas la valeur NULL, ce paramètre est traité comme un paramètre [out], qui pointe vers une structure FILETIME dans laquelle la fonction place l’horodatage du dernier appel SHSetUnreadMailCount pour l’utilisateur et le compte de messagerie spécifiés.

[out, optional] pszShellExecuteCommand

Type : LPCTSTR

Pointeur vers une chaîne qui retourne l’instruction de commande ShellExecute passée dans le dernier appel SHSetUnreadMailCount pour l’utilisateur et le compte de messagerie spécifiés. Cette chaîne de commande démarre l’application de messagerie qui possède le compte référencé par pszMailAddress. Si la commande ShellExecute n’est pas requise, ce paramètre peut avoir la valeur NULL. Si pszMailAddress a la valeur NULL, ce paramètre est ignoré et doit avoir la valeur NULL.

cchShellExecuteCommand

Type : int

Taille maximale, en caractères, de la mémoire tampon de commande ShellExecute pointée vers pszShellExecuteCommand. Ce paramètre doit être égal à zéro pour le nombre total lorsque pszMailAddress a la valeur NULL. Elle peut également être NULL chaque fois que la chaîne de commande ShellExecute n’est pas requise.

Valeur retournée

Type : HRESULT

Si cette fonction 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 shellapi.h
Bibliothèque Shell32.lib
DLL Shell32.dll (version 6.0 ou ultérieure)