Win32 API 日本語リファレンス
ホームUI.Shell › SHEnumerateUnreadMailAccountsW

SHEnumerateUnreadMailAccountsW

関数
未読メールアカウントを列挙してアドレスを取得する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHEnumerateUnreadMailAccountsW(
    HKEY hKeyUser,   // optional
    DWORD dwIndex,
    LPWSTR pszMailAddress,
    INT cchMailAddress
);

パラメーター

名前方向説明
hKeyUserHKEYinoptional指定したユーザーの有効な HKEY。
dwIndexDWORDinユーザーアカウントのインデックス。
pszMailAddressLPWSTRout指定したユーザーに属するアカウントのメールアドレスを指定する Unicode 文字列へのポインター。
cchMailAddressINTinメールアドレスの文字数。

戻り値の型: HRESULT

公式ドキュメント

未読メールを持つユーザーアカウントを列挙します。(Unicode)

戻り値

型: HRESULT

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

解説(Remarks)

hKeyUser パラメーターは、ユーザー情報のルートを表す HKEY です。たとえば HKEY_CURRENT_USER や、HKEY_USERS 配下に列挙される任意のキーが該当します。

メモ

shellapi.h ヘッダーは、SHEnumerateUnreadMailAccounts を、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SHEnumerateUnreadMailAccountsW(
    HKEY hKeyUser,   // optional
    DWORD dwIndex,
    LPWSTR pszMailAddress,
    INT cchMailAddress
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHEnumerateUnreadMailAccountsW(
    IntPtr hKeyUser,   // HKEY optional
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszMailAddress,   // LPWSTR out
    int cchMailAddress   // INT
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHEnumerateUnreadMailAccountsW(
    hKeyUser As IntPtr,   ' HKEY optional
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszMailAddress As System.Text.StringBuilder,   ' LPWSTR out
    cchMailAddress As Integer   ' INT
) As Integer
End Function
' hKeyUser : HKEY optional
' dwIndex : DWORD
' pszMailAddress : LPWSTR out
' cchMailAddress : INT
Declare PtrSafe Function SHEnumerateUnreadMailAccountsW Lib "shell32" ( _
    ByVal hKeyUser As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal pszMailAddress As LongPtr, _
    ByVal cchMailAddress 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

SHEnumerateUnreadMailAccountsW = ctypes.windll.shell32.SHEnumerateUnreadMailAccountsW
SHEnumerateUnreadMailAccountsW.restype = ctypes.c_int
SHEnumerateUnreadMailAccountsW.argtypes = [
    wintypes.HANDLE,  # hKeyUser : HKEY optional
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPWSTR,  # pszMailAddress : LPWSTR out
    ctypes.c_int,  # cchMailAddress : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHEnumerateUnreadMailAccountsW = Fiddle::Function.new(
  lib['SHEnumerateUnreadMailAccountsW'],
  [
    Fiddle::TYPE_VOIDP,  # hKeyUser : HKEY optional
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pszMailAddress : LPWSTR out
    Fiddle::TYPE_INT,  # cchMailAddress : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn SHEnumerateUnreadMailAccountsW(
        hKeyUser: *mut core::ffi::c_void,  // HKEY optional
        dwIndex: u32,  // DWORD
        pszMailAddress: *mut u16,  // LPWSTR out
        cchMailAddress: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHEnumerateUnreadMailAccountsW(IntPtr hKeyUser, uint dwIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszMailAddress, int cchMailAddress);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHEnumerateUnreadMailAccountsW' -Namespace Win32 -PassThru
# $api::SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
#uselib "SHELL32.dll"
#func global SHEnumerateUnreadMailAccountsW "SHEnumerateUnreadMailAccountsW" wptr, wptr, wptr, wptr
; SHEnumerateUnreadMailAccountsW hKeyUser, dwIndex, varptr(pszMailAddress), cchMailAddress   ; 戻り値は stat
; hKeyUser : HKEY optional -> "wptr"
; dwIndex : DWORD -> "wptr"
; pszMailAddress : LPWSTR out -> "wptr"
; cchMailAddress : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHEnumerateUnreadMailAccountsW "SHEnumerateUnreadMailAccountsW" sptr, int, var, int
; res = SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
; hKeyUser : HKEY optional -> "sptr"
; dwIndex : DWORD -> "int"
; pszMailAddress : LPWSTR out -> "var"
; cchMailAddress : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHEnumerateUnreadMailAccountsW(HKEY hKeyUser, DWORD dwIndex, LPWSTR pszMailAddress, INT cchMailAddress)
#uselib "SHELL32.dll"
#cfunc global SHEnumerateUnreadMailAccountsW "SHEnumerateUnreadMailAccountsW" intptr, int, var, int
; res = SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
; hKeyUser : HKEY optional -> "intptr"
; dwIndex : DWORD -> "int"
; pszMailAddress : LPWSTR out -> "var"
; cchMailAddress : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHEnumerateUnreadMailAccountsW = shell32.NewProc("SHEnumerateUnreadMailAccountsW")
)

// hKeyUser (HKEY optional), dwIndex (DWORD), pszMailAddress (LPWSTR out), cchMailAddress (INT)
r1, _, err := procSHEnumerateUnreadMailAccountsW.Call(
	uintptr(hKeyUser),
	uintptr(dwIndex),
	uintptr(pszMailAddress),
	uintptr(cchMailAddress),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHEnumerateUnreadMailAccountsW(
  hKeyUser: THandle;   // HKEY optional
  dwIndex: DWORD;   // DWORD
  pszMailAddress: PWideChar;   // LPWSTR out
  cchMailAddress: Integer   // INT
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHEnumerateUnreadMailAccountsW';
result := DllCall("SHELL32\SHEnumerateUnreadMailAccountsW"
    , "Ptr", hKeyUser   ; HKEY optional
    , "UInt", dwIndex   ; DWORD
    , "Ptr", pszMailAddress   ; LPWSTR out
    , "Int", cchMailAddress   ; INT
    , "Int")   ; return: HRESULT
●SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress) = DLL("SHELL32.dll", "int SHEnumerateUnreadMailAccountsW(void*, dword, char*, int)")
# 呼び出し: SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
# hKeyUser : HKEY optional -> "void*"
# dwIndex : DWORD -> "dword"
# pszMailAddress : LPWSTR out -> "char*"
# cchMailAddress : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn SHEnumerateUnreadMailAccountsW(
    hKeyUser: ?*anyopaque, // HKEY optional
    dwIndex: u32, // DWORD
    pszMailAddress: [*c]u16, // LPWSTR out
    cchMailAddress: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHEnumerateUnreadMailAccountsW(
    hKeyUser: pointer,  # HKEY optional
    dwIndex: uint32,  # DWORD
    pszMailAddress: ptr uint16,  # LPWSTR out
    cchMailAddress: int32  # INT
): int32 {.importc: "SHEnumerateUnreadMailAccountsW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
int SHEnumerateUnreadMailAccountsW(
    void* hKeyUser,   // HKEY optional
    uint dwIndex,   // DWORD
    wchar* pszMailAddress,   // LPWSTR out
    int cchMailAddress   // INT
);
ccall((:SHEnumerateUnreadMailAccountsW, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt16}, Int32),
      hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
# hKeyUser : HKEY optional -> Ptr{Cvoid}
# dwIndex : DWORD -> UInt32
# pszMailAddress : LPWSTR out -> Ptr{UInt16}
# cchMailAddress : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHEnumerateUnreadMailAccountsW(
    void* hKeyUser,
    uint32_t dwIndex,
    uint16_t* pszMailAddress,
    int32_t cchMailAddress);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
-- hKeyUser : HKEY optional
-- dwIndex : DWORD
-- pszMailAddress : LPWSTR out
-- cchMailAddress : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHEnumerateUnreadMailAccountsW = lib.func('__stdcall', 'SHEnumerateUnreadMailAccountsW', 'int32_t', ['void *', 'uint32_t', 'uint16_t *', 'int32_t']);
// SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
// hKeyUser : HKEY optional -> 'void *'
// dwIndex : DWORD -> 'uint32_t'
// pszMailAddress : LPWSTR out -> 'uint16_t *'
// cchMailAddress : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHEnumerateUnreadMailAccountsW: { parameters: ["pointer", "u32", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress)
// hKeyUser : HKEY optional -> "pointer"
// dwIndex : DWORD -> "u32"
// pszMailAddress : LPWSTR out -> "buffer"
// cchMailAddress : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHEnumerateUnreadMailAccountsW(
    void* hKeyUser,
    uint32_t dwIndex,
    uint16_t* pszMailAddress,
    int32_t cchMailAddress);
C, "SHELL32.dll");
// $ffi->SHEnumerateUnreadMailAccountsW(hKeyUser, dwIndex, pszMailAddress, cchMailAddress);
// hKeyUser : HKEY optional
// dwIndex : DWORD
// pszMailAddress : LPWSTR out
// cchMailAddress : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.UNICODE_OPTIONS);
    int SHEnumerateUnreadMailAccountsW(
        Pointer hKeyUser,   // HKEY optional
        int dwIndex,   // DWORD
        char[] pszMailAddress,   // LPWSTR out
        int cchMailAddress   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHEnumerateUnreadMailAccountsW = SHEnumerateUnreadMailAccountsW(
    hKeyUser : Void*,   # HKEY optional
    dwIndex : UInt32,   # DWORD
    pszMailAddress : UInt16*,   # LPWSTR out
    cchMailAddress : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHEnumerateUnreadMailAccountsWNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Int32);
typedef SHEnumerateUnreadMailAccountsWDart = int Function(Pointer<Void>, int, Pointer<Utf16>, int);
final SHEnumerateUnreadMailAccountsW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHEnumerateUnreadMailAccountsWNative, SHEnumerateUnreadMailAccountsWDart>('SHEnumerateUnreadMailAccountsW');
// hKeyUser : HKEY optional -> Pointer<Void>
// dwIndex : DWORD -> Uint32
// pszMailAddress : LPWSTR out -> Pointer<Utf16>
// cchMailAddress : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHEnumerateUnreadMailAccountsW(
  hKeyUser: THandle;   // HKEY optional
  dwIndex: DWORD;   // DWORD
  pszMailAddress: PWideChar;   // LPWSTR out
  cchMailAddress: Integer   // INT
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHEnumerateUnreadMailAccountsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHEnumerateUnreadMailAccountsW"
  c_SHEnumerateUnreadMailAccountsW :: Ptr () -> Word32 -> CWString -> Int32 -> IO Int32
-- hKeyUser : HKEY optional -> Ptr ()
-- dwIndex : DWORD -> Word32
-- pszMailAddress : LPWSTR out -> CWString
-- cchMailAddress : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shenumerateunreadmailaccountsw =
  foreign "SHEnumerateUnreadMailAccountsW"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* hKeyUser : HKEY optional -> (ptr void) *)
(* dwIndex : DWORD -> uint32_t *)
(* pszMailAddress : LPWSTR out -> (ptr uint16_t) *)
(* cchMailAddress : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHEnumerateUnreadMailAccountsW" shenumerate-unread-mail-accounts-w :convention :stdcall) :int32
  (h-key-user :pointer)   ; HKEY optional
  (dw-index :uint32)   ; DWORD
  (psz-mail-address :pointer)   ; LPWSTR out
  (cch-mail-address :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHEnumerateUnreadMailAccountsW = Win32::API::More->new('SHELL32',
    'int SHEnumerateUnreadMailAccountsW(HANDLE hKeyUser, DWORD dwIndex, LPWSTR pszMailAddress, int cchMailAddress)');
# my $ret = $SHEnumerateUnreadMailAccountsW->Call($hKeyUser, $dwIndex, $pszMailAddress, $cchMailAddress);
# hKeyUser : HKEY optional -> HANDLE
# dwIndex : DWORD -> DWORD
# pszMailAddress : LPWSTR out -> LPWSTR
# cchMailAddress : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。