SHGetUnreadMailCountW 関数 (shellapi.h)

任意またはすべてのメール アカウントの指定したユーザーの未読メッセージ数を取得します。

構文

HRESULT SHGetUnreadMailCountW(
  [in, optional]  HKEY     hKeyUser,
  [in, optional]  LPCWSTR  pszMailAddress,
  [out, optional] DWORD    *pdwCount,
  [out, optional] FILETIME *pFileTime,
  [out, optional] LPWSTR   pszShellExecuteCommand,
                  int      cchShellExecuteCommand
);

パラメーター

[in, optional] hKeyUser

種類: HKEY

特定のユーザーの有効な HKEY。 このパラメーターは、ユーザーの環境で関数が呼び出される場合は NULL にする必要があります。この場合 、HKEY_CURRENT_USER が使用されます。 関数が SYSTEM コンテキストから呼び出される場合、このパラメーターは NULL にする必要があります。この場合 、HKEY_USERS\{SID} が 使用されます。

[in, optional] pszMailAddress

種類: LPCTSTR

指定したユーザーに属するアカウントの電子メール アドレスを指定する Unicode の文字列へのポインター。 このパラメーターが NULL の場合、 pdwCount は、指定されたユーザーが所有するすべてのアカウントの未読メッセージの合計数を返します。

[out, optional] pdwCount

型: DWORD*

未読メッセージ数を受け取る DWORD 値へのポインター。

[out, optional] pFileTime

種類: FILETIME*

FILETIME 構造体へのポインター。 このパラメーターの使用は、 pszMailAddress が NULL かどうかによって決まります。 pszMailAddress が NULL の場合、このパラメーターはフィルターを指定する [in] パラメーターとして扱われ、指定された時刻より新しい未読メールのみが表示されます。 pszMailAddress が NULL でない場合、このパラメーターは [out] パラメーターとして扱われます。このパラメーターは FILETIME 構造体を指します。このパラメーターは、関数が、指定されたユーザーおよび電子メール アカウントに対する最後の SHSetUnreadMailCount 呼び出しのタイムスタンプを格納する FILETIME 構造体を指します。

[out, optional] pszShellExecuteCommand

種類: LPCTSTR

指定したユーザーおよび電子メール アカウントの最後の SHSetUnreadMailCount 呼び出しに渡された ShellExecute コマンド ステートメントを返す文字列へのポインター。 このコマンド文字列は、 pszMailAddress によって参照されるアカウントを所有する電子メール アプリケーションを起動します。 ShellExecute コマンドが必要ない場合は、このパラメーターに NULL を指定できます。 pszMailAddress が NULL の場合、このパラメーターは無視され、NULL である必要があります。

cchShellExecuteCommand

型: int

pszShellExecuteCommand が指す ShellExecute コマンド バッファーの最大サイズ (文字数)。 pszMailAddress が NULL の場合、合計カウントでは、このパラメーターは 0 である必要があります。 ShellExecute コマンド文字列が必要ない場合は常に NULL にすることもできます。

戻り値

型: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム	Windows
ヘッダー	shellapi.h
Library	Shell32.lib
[DLL]	Shell32.dll (バージョン 6.0 以降)