ホーム › UI.Shell › SHGetUnreadMailCountW

SHGetUnreadMailCountW

関数

指定アカウントの未読メール件数を取得する。

DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHGetUnreadMailCountW(
    HKEY hKeyUser,   // optional
    LPCWSTR pszMailAddress,   // optional
    DWORD* pdwCount,   // optional
    FILETIME* pFileTime,   // optional
    LPWSTR pszShellExecuteCommand,   // optional
    INT cchShellExecuteCommand
);

パラメーター

名前	型	方向	説明
hKeyUser	HKEY	inoptional	指定したユーザーに対応する有効な HKEY。この関数がユーザー環境内で呼び出される場合、このパラメーターは NULL にする必要があり、その場合は HKEY_CURRENT_USER が使用されます。この関数が SYSTEM コンテキストから呼び出される場合も、このパラメーターは NULL にする必要があり、その場合は HKEY_USERS\{SID} が使用されます。
pszMailAddress	LPCWSTR	inoptional	指定したユーザーに属するアカウントの電子メールアドレスを指定する、Unicode 文字列へのポインター。このパラメーターが NULL の場合、pdwCount には指定したユーザーが所有するすべてのアカウントの未読メッセージ総数が返されます。
pdwCount	DWORD*	outoptional	未読メッセージ数を受け取る DWORD 値へのポインター。
pFileTime	FILETIME*	outoptional	FILETIME 構造体へのポインター。このパラメーターの用途は、pszMailAddress が NULL かどうかによって決まります。pszMailAddress が NULL の場合、このパラメーターは [in] パラメーターとして扱われ、フィルターを指定します。これにより、指定した時刻より新しい未読メールのみが対象になります。pszMailAddress が NULL でない場合、このパラメーターは [out] パラメーターとして扱われ、FILETIME 構造体を指します。この関数は、指定したユーザーおよび電子メールアカウントに対する最後の SHSetUnreadMailCount 呼び出しのタイムスタンプを、その構造体に格納します。
pszShellExecuteCommand	LPWSTR	outoptional	指定したユーザーおよび電子メールアカウントに対する最後の SHSetUnreadMailCount 呼び出しに渡された ShellExecute コマンド文を返す文字列へのポインター。このコマンド文字列は、pszMailAddress で参照されるアカウントを所有する電子メールアプリケーションを起動します。ShellExecute コマンドが不要な場合、このパラメーターは NULL にできます。pszMailAddress が NULL の場合、このパラメーターは無視され、NULL にする必要があります。
cchShellExecuteCommand	INT	in	pszShellExecuteCommand が指す ShellExecute コマンドバッファーの最大サイズ(文字数)。pszMailAddress が NULL の総数取得の場合、このパラメーターは 0 にする必要があります。また、ShellExecute コマンド文字列が不要な場合は NULL にすることもできます。

戻り値の型: HRESULT

公式ドキュメント

指定したユーザーの、いずれかまたはすべての電子メールアカウントにおける未読メッセージ数を取得します。(Unicode)

戻り値

Type: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHGetUnreadMailCountW(
    HKEY hKeyUser,   // optional
    LPCWSTR pszMailAddress,   // optional
    DWORD* pdwCount,   // optional
    FILETIME* pFileTime,   // optional
    LPWSTR pszShellExecuteCommand,   // optional
    INT cchShellExecuteCommand
);

[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHGetUnreadMailCountW(
    IntPtr hKeyUser,   // HKEY optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszMailAddress,   // LPCWSTR optional
    IntPtr pdwCount,   // DWORD* optional, out
    IntPtr pFileTime,   // FILETIME* optional, out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszShellExecuteCommand,   // LPWSTR optional, out
    int cchShellExecuteCommand   // INT
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetUnreadMailCountW(
    hKeyUser As IntPtr,   ' HKEY optional
    <MarshalAs(UnmanagedType.LPWStr)> pszMailAddress As String,   ' LPCWSTR optional
    pdwCount As IntPtr,   ' DWORD* optional, out
    pFileTime As IntPtr,   ' FILETIME* optional, out
    <MarshalAs(UnmanagedType.LPWStr)> pszShellExecuteCommand As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchShellExecuteCommand As Integer   ' INT
) As Integer
End Function

' hKeyUser : HKEY optional
' pszMailAddress : LPCWSTR optional
' pdwCount : DWORD* optional, out
' pFileTime : FILETIME* optional, out
' pszShellExecuteCommand : LPWSTR optional, out
' cchShellExecuteCommand : INT
Declare PtrSafe Function SHGetUnreadMailCountW Lib "shell32" ( _
    ByVal hKeyUser As LongPtr, _
    ByVal pszMailAddress As LongPtr, _
    ByVal pdwCount As LongPtr, _
    ByVal pFileTime As LongPtr, _
    ByVal pszShellExecuteCommand As LongPtr, _
    ByVal cchShellExecuteCommand As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetUnreadMailCountW = ctypes.windll.shell32.SHGetUnreadMailCountW
SHGetUnreadMailCountW.restype = ctypes.c_int
SHGetUnreadMailCountW.argtypes = [
    wintypes.HANDLE,  # hKeyUser : HKEY optional
    wintypes.LPCWSTR,  # pszMailAddress : LPCWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # pdwCount : DWORD* optional, out
    ctypes.c_void_p,  # pFileTime : FILETIME* optional, out
    wintypes.LPWSTR,  # pszShellExecuteCommand : LPWSTR optional, out
    ctypes.c_int,  # cchShellExecuteCommand : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetUnreadMailCountW = Fiddle::Function.new(
  lib['SHGetUnreadMailCountW'],
  [
    Fiddle::TYPE_VOIDP,  # hKeyUser : HKEY optional
    Fiddle::TYPE_VOIDP,  # pszMailAddress : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pdwCount : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pFileTime : FILETIME* optional, out
    Fiddle::TYPE_VOIDP,  # pszShellExecuteCommand : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchShellExecuteCommand : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shell32")]
extern "system" {
    fn SHGetUnreadMailCountW(
        hKeyUser: *mut core::ffi::c_void,  // HKEY optional
        pszMailAddress: *const u16,  // LPCWSTR optional
        pdwCount: *mut u32,  // DWORD* optional, out
        pFileTime: *mut FILETIME,  // FILETIME* optional, out
        pszShellExecuteCommand: *mut u16,  // LPWSTR optional, out
        cchShellExecuteCommand: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHGetUnreadMailCountW(IntPtr hKeyUser, [MarshalAs(UnmanagedType.LPWStr)] string pszMailAddress, IntPtr pdwCount, IntPtr pFileTime, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszShellExecuteCommand, int cchShellExecuteCommand);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetUnreadMailCountW' -Namespace Win32 -PassThru
# $api::SHGetUnreadMailCountW(hKeyUser, pszMailAddress, pdwCount, pFileTime, pszShellExecuteCommand, cchShellExecuteCommand)

#uselib "SHELL32.dll"
#func global SHGetUnreadMailCountW "SHGetUnreadMailCountW" wptr, wptr, wptr, wptr, wptr, wptr
; SHGetUnreadMailCountW hKeyUser, pszMailAddress, varptr(pdwCount), varptr(pFileTime), varptr(pszShellExecuteCommand), cchShellExecuteCommand   ; 戻り値は stat
; hKeyUser : HKEY optional -> "wptr"
; pszMailAddress : LPCWSTR optional -> "wptr"
; pdwCount : DWORD* optional, out -> "wptr"
; pFileTime : FILETIME* optional, out -> "wptr"
; pszShellExecuteCommand : LPWSTR optional, out -> "wptr"
; cchShellExecuteCommand : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHGetUnreadMailCountW "SHGetUnreadMailCountW" sptr, wstr, var, var, var, int
; res = SHGetUnreadMailCountW(hKeyUser, pszMailAddress, pdwCount, pFileTime, pszShellExecuteCommand, cchShellExecuteCommand)
; hKeyUser : HKEY optional -> "sptr"
; pszMailAddress : LPCWSTR optional -> "wstr"
; pdwCount : DWORD* optional, out -> "var"
; pFileTime : FILETIME* optional, out -> "var"
; pszShellExecuteCommand : LPWSTR optional, out -> "var"
; cchShellExecuteCommand : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetUnreadMailCountW "SHGetUnreadMailCountW" sptr, wstr, sptr, sptr, sptr, int
; res = SHGetUnreadMailCountW(hKeyUser, pszMailAddress, varptr(pdwCount), varptr(pFileTime), varptr(pszShellExecuteCommand), cchShellExecuteCommand)
; hKeyUser : HKEY optional -> "sptr"
; pszMailAddress : LPCWSTR optional -> "wstr"
; pdwCount : DWORD* optional, out -> "sptr"
; pFileTime : FILETIME* optional, out -> "sptr"
; pszShellExecuteCommand : LPWSTR optional, out -> "sptr"
; cchShellExecuteCommand : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。