SHGetUnreadMailCountA-Funktion (shellapi.h)

Ruft die Anzahl der ungelesenen Nachrichten eines angegebenen Benutzers für ein oder alle E-Mail-Konten ab.

Syntax

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

Parameter

[in, optional] hKeyUser

Typ: HKEY

Ein gültiger HKEY für einen bestimmten Benutzer. Dieser Parameter sollte NULL sein, wenn die Funktion in der Umgebung eines Benutzers aufgerufen wird. In diesem Fall wird HKEY_CURRENT_USER verwendet. Dieser Parameter sollte NULL sein, wenn die Funktion aus dem SYSTEM-Kontext aufgerufen wird. In diesem Fall wird HKEY_USERS\{SID} verwendet.

[in, optional] pszMailAddress

Typ: LPCTSTR

Ein Zeiger auf eine Zeichenfolge in Unicode, die die E-Mail-Adresse eines Kontos angibt, das zum angegebenen Benutzer gehört. Wenn dieser Parameter NULL ist, gibt pdwCount die Gesamtanzahl der ungelesenen Nachrichten für alle Konten zurück, die dem angegebenen Benutzer gehören.

[out, optional] pdwCount

Typ: DWORD*

Zeiger auf einen DWORD-Wert, der die Anzahl der ungelesenen Nachrichten empfängt.

[out, optional] pFileTime

Typ: FILETIME*

Ein Zeiger auf eine FILETIME-Struktur . Die Verwendung dieses Parameters wird dadurch bestimmt, ob pszMailAddressNULL ist. Wenn pszMailAddressNULL ist, wird dieser Parameter als [in]-Parameter behandelt, der einen Filter angibt, sodass nur ungelesene E-Mails angezeigt werden, die neuer als die angegebene Zeit sind. Wenn pszMailAddress nicht NULL ist, wird dieser Parameter als [out]-Parameter behandelt, der auf eine FILETIME-Struktur verweist, in der die Funktion den Zeitstempel des letzten SHSetUnreadMailCount-Aufrufs für den angegebenen Benutzer und E-Mail-Konto platziert.

[out, optional] pszShellExecuteCommand

Typ: LPCTSTR

Ein Zeiger auf eine Zeichenfolge, die die ShellExecute-Befehlsanweisung zurückgibt, die an den letzten SHSetUnreadMailCount-Aufruf für den angegebenen Benutzer und das angegebene E-Mail-Konto übergeben wurde. Mit dieser Befehlszeichenfolge wird die E-Mail-Anwendung gestartet, die das Konto besitzt, auf das von pszMailAddress verwiesen wird. Wenn der ShellExecute-Befehl nicht erforderlich ist, kann dieser Parameter NULL sein. Wenn pszMailAddressNULL ist, wird dieser Parameter ignoriert und muss NULL sein.

cchShellExecuteCommand

Typ: int

Die maximale Größe des ShellExecute-Befehlspuffers in Zeichen, auf die mit pszShellExecuteCommand verwiesen wird. Dieser Parameter muss null für die Gesamtanzahl sein, wenn pszMailAddressNULL ist. Es kann auch NULL sein, wenn die ShellExecute-Befehlszeichenfolge nicht erforderlich ist.

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Anforderungen