Win32 API 日本語リファレンス
ホームSecurity.Credentials › CredEnumerateW

CredEnumerateW

関数
フィルタに一致する資格情報を列挙する。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CredEnumerateW(
    LPCWSTR Filter,   // optional
    CRED_ENUMERATE_FLAGS Flags,   // optional
    DWORD* Count,
    CREDENTIALW*** Credential
);

パラメーター

名前方向説明
FilterLPCWSTRinoptional

返される資格情報のフィルターを格納した null で終わる文字列へのポインターです。TargetName がフィルターに一致する資格情報のみが返されます。フィルターには、名前のプレフィックスに続けてアスタリスクを指定します。たとえば、フィルター "FRED*" は、TargetName が文字列 "FRED" で始まるすべての資格情報を返します。

NULL を指定した場合は、すべての資格情報が返されます。

FlagsCRED_ENUMERATE_FLAGSoptional

このパラメーターの値には、次の値のうち 0 個以上をビットごとの OR 演算で組み合わせたものを指定できます。

Value Meaning
CRED_ENUMERATE_ALL_CREDENTIALS
0x1
この関数は、ユーザーの資格情報セット内のすべての資格情報を列挙します。各資格情報のターゲット名は "namespace:attribute=target" 形式で返されます。このフラグが設定されており、かつ Filter パラメーターが NULL でない場合、関数は失敗し ERROR_INVALID_FLAGS を返します。

Windows Server 2003 および Windows XP: このフラグはサポートされていません。

CountDWORD*outCredentials 配列で返される資格情報の数です。
CredentialCREDENTIALW***out資格情報へのポインターの配列を指すポインターです。 返される資格情報は、単一の割り当てブロックです。バッファー内に含まれるすべてのポインターは、この単一の割り当てブロック内の位置を指します。返された単一のバッファーは、CredFree を呼び出して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

ユーザーの資格情報セットから資格情報を列挙します。(Unicode)

戻り値

この関数は、成功した場合は TRUE を、失敗した場合は FALSE を返します。より詳細なステータスコードを取得するには、GetLastError 関数を呼び出します。返される可能性があるステータスコードは次のとおりです。

Return code/value Description
ERROR_NOT_FOUND
1168 (0x490)
指定された Filter に一致する資格情報が存在しません。
ERROR_NO_SUCH_LOGON_SESSION
1312 (0x520)
ログオンセッションが存在しないか、このログオンセッションに関連付けられた資格情報セットがありません。ネットワークログオンセッションには、関連付けられた資格情報セットはありません。
ERROR_INVALID_FLAGS
1004 (0x3EC)
Flags パラメーターに無効なフラグが指定されたか、Flags パラメーターに CRED_ENUMERATE_ALL_CREDENTIALS が指定され、かつ Filter パラメーターが NULL でない場合です。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

BOOL CredEnumerateW(
    LPCWSTR Filter,   // optional
    CRED_ENUMERATE_FLAGS Flags,   // optional
    DWORD* Count,
    CREDENTIALW*** Credential
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredEnumerateW(
    [MarshalAs(UnmanagedType.LPWStr)] string Filter,   // LPCWSTR optional
    uint Flags,   // CRED_ENUMERATE_FLAGS optional
    out uint Count,   // DWORD* out
    IntPtr Credential   // CREDENTIALW*** out
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredEnumerateW(
    <MarshalAs(UnmanagedType.LPWStr)> Filter As String,   ' LPCWSTR optional
    Flags As UInteger,   ' CRED_ENUMERATE_FLAGS optional
    <Out> ByRef Count As UInteger,   ' DWORD* out
    Credential As IntPtr   ' CREDENTIALW*** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Filter : LPCWSTR optional
' Flags : CRED_ENUMERATE_FLAGS optional
' Count : DWORD* out
' Credential : CREDENTIALW*** out
Declare PtrSafe Function CredEnumerateW Lib "advapi32" ( _
    ByVal Filter As LongPtr, _
    ByVal Flags As Long, _
    ByRef Count As Long, _
    ByVal Credential As LongPtr) 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

CredEnumerateW = ctypes.windll.advapi32.CredEnumerateW
CredEnumerateW.restype = wintypes.BOOL
CredEnumerateW.argtypes = [
    wintypes.LPCWSTR,  # Filter : LPCWSTR optional
    wintypes.DWORD,  # Flags : CRED_ENUMERATE_FLAGS optional
    ctypes.POINTER(wintypes.DWORD),  # Count : DWORD* out
    ctypes.c_void_p,  # Credential : CREDENTIALW*** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredEnumerateW = Fiddle::Function.new(
  lib['CredEnumerateW'],
  [
    Fiddle::TYPE_VOIDP,  # Filter : LPCWSTR optional
    -Fiddle::TYPE_INT,  # Flags : CRED_ENUMERATE_FLAGS optional
    Fiddle::TYPE_VOIDP,  # Count : DWORD* out
    Fiddle::TYPE_VOIDP,  # Credential : CREDENTIALW*** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn CredEnumerateW(
        Filter: *const u16,  // LPCWSTR optional
        Flags: u32,  // CRED_ENUMERATE_FLAGS optional
        Count: *mut u32,  // DWORD* out
        Credential: *mut *mut *mut CREDENTIALW  // CREDENTIALW*** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CredEnumerateW([MarshalAs(UnmanagedType.LPWStr)] string Filter, uint Flags, out uint Count, IntPtr Credential);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredEnumerateW' -Namespace Win32 -PassThru
# $api::CredEnumerateW(Filter, Flags, Count, Credential)
#uselib "ADVAPI32.dll"
#func global CredEnumerateW "CredEnumerateW" wptr, wptr, wptr, wptr
; CredEnumerateW Filter, Flags, varptr(Count), varptr(Credential)   ; 戻り値は stat
; Filter : LPCWSTR optional -> "wptr"
; Flags : CRED_ENUMERATE_FLAGS optional -> "wptr"
; Count : DWORD* out -> "wptr"
; Credential : CREDENTIALW*** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ADVAPI32.dll"
#cfunc global CredEnumerateW "CredEnumerateW" wstr, int, var, var
; res = CredEnumerateW(Filter, Flags, Count, Credential)
; Filter : LPCWSTR optional -> "wstr"
; Flags : CRED_ENUMERATE_FLAGS optional -> "int"
; Count : DWORD* out -> "var"
; Credential : CREDENTIALW*** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CredEnumerateW(LPCWSTR Filter, CRED_ENUMERATE_FLAGS Flags, DWORD* Count, CREDENTIALW*** Credential)
#uselib "ADVAPI32.dll"
#cfunc global CredEnumerateW "CredEnumerateW" wstr, int, var, var
; res = CredEnumerateW(Filter, Flags, Count, Credential)
; Filter : LPCWSTR optional -> "wstr"
; Flags : CRED_ENUMERATE_FLAGS optional -> "int"
; Count : DWORD* out -> "var"
; Credential : CREDENTIALW*** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procCredEnumerateW = advapi32.NewProc("CredEnumerateW")
)

// Filter (LPCWSTR optional), Flags (CRED_ENUMERATE_FLAGS optional), Count (DWORD* out), Credential (CREDENTIALW*** out)
r1, _, err := procCredEnumerateW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Filter))),
	uintptr(Flags),
	uintptr(Count),
	uintptr(Credential),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CredEnumerateW(
  Filter: PWideChar;   // LPCWSTR optional
  Flags: DWORD;   // CRED_ENUMERATE_FLAGS optional
  Count: Pointer;   // DWORD* out
  Credential: Pointer   // CREDENTIALW*** out
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CredEnumerateW';
result := DllCall("ADVAPI32\CredEnumerateW"
    , "WStr", Filter   ; LPCWSTR optional
    , "UInt", Flags   ; CRED_ENUMERATE_FLAGS optional
    , "Ptr", Count   ; DWORD* out
    , "Ptr", Credential   ; CREDENTIALW*** out
    , "Int")   ; return: BOOL
●CredEnumerateW(Filter, Flags, Count, Credential) = DLL("ADVAPI32.dll", "bool CredEnumerateW(char*, dword, void*, void*)")
# 呼び出し: CredEnumerateW(Filter, Flags, Count, Credential)
# Filter : LPCWSTR optional -> "char*"
# Flags : CRED_ENUMERATE_FLAGS optional -> "dword"
# Count : DWORD* out -> "void*"
# Credential : CREDENTIALW*** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advapi32" fn CredEnumerateW(
    Filter: [*c]const u16, // LPCWSTR optional
    Flags: u32, // CRED_ENUMERATE_FLAGS optional
    Count: [*c]u32, // DWORD* out
    Credential: [*c][*c][*c]CREDENTIALW // CREDENTIALW*** out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CredEnumerateW(
    Filter: WideCString,  # LPCWSTR optional
    Flags: uint32,  # CRED_ENUMERATE_FLAGS optional
    Count: ptr uint32,  # DWORD* out
    Credential: ptr CREDENTIALW  # CREDENTIALW*** out
): int32 {.importc: "CredEnumerateW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int CredEnumerateW(
    const(wchar)* Filter,   // LPCWSTR optional
    uint Flags,   // CRED_ENUMERATE_FLAGS optional
    uint* Count,   // DWORD* out
    CREDENTIALW*** Credential   // CREDENTIALW*** out
);
ccall((:CredEnumerateW, "ADVAPI32.dll"), stdcall, Int32,
      (Cwstring, UInt32, Ptr{UInt32}, Ptr{CREDENTIALW}),
      Filter, Flags, Count, Credential)
# Filter : LPCWSTR optional -> Cwstring
# Flags : CRED_ENUMERATE_FLAGS optional -> UInt32
# Count : DWORD* out -> Ptr{UInt32}
# Credential : CREDENTIALW*** out -> Ptr{CREDENTIALW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t CredEnumerateW(
    const uint16_t* Filter,
    uint32_t Flags,
    uint32_t* Count,
    void* Credential);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CredEnumerateW(Filter, Flags, Count, Credential)
-- Filter : LPCWSTR optional
-- Flags : CRED_ENUMERATE_FLAGS optional
-- Count : DWORD* out
-- Credential : CREDENTIALW*** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CredEnumerateW = lib.func('__stdcall', 'CredEnumerateW', 'int32_t', ['str16', 'uint32_t', 'uint32_t *', 'void *']);
// CredEnumerateW(Filter, Flags, Count, Credential)
// Filter : LPCWSTR optional -> 'str16'
// Flags : CRED_ENUMERATE_FLAGS optional -> 'uint32_t'
// Count : DWORD* out -> 'uint32_t *'
// Credential : CREDENTIALW*** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  CredEnumerateW: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.CredEnumerateW(Filter, Flags, Count, Credential)
// Filter : LPCWSTR optional -> "buffer"
// Flags : CRED_ENUMERATE_FLAGS optional -> "u32"
// Count : DWORD* out -> "pointer"
// Credential : CREDENTIALW*** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CredEnumerateW(
    const uint16_t* Filter,
    uint32_t Flags,
    uint32_t* Count,
    void* Credential);
C, "ADVAPI32.dll");
// $ffi->CredEnumerateW(Filter, Flags, Count, Credential);
// Filter : LPCWSTR optional
// Flags : CRED_ENUMERATE_FLAGS optional
// Count : DWORD* out
// Credential : CREDENTIALW*** out
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean CredEnumerateW(
        WString Filter,   // LPCWSTR optional
        int Flags,   // CRED_ENUMERATE_FLAGS optional
        IntByReference Count,   // DWORD* out
        Pointer Credential   // CREDENTIALW*** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun CredEnumerateW = CredEnumerateW(
    Filter : UInt16*,   # LPCWSTR optional
    Flags : UInt32,   # CRED_ENUMERATE_FLAGS optional
    Count : UInt32*,   # DWORD* out
    Credential : CREDENTIALW***   # CREDENTIALW*** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CredEnumerateWNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef CredEnumerateWDart = int Function(Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Void>);
final CredEnumerateW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CredEnumerateWNative, CredEnumerateWDart>('CredEnumerateW');
// Filter : LPCWSTR optional -> Pointer<Utf16>
// Flags : CRED_ENUMERATE_FLAGS optional -> Uint32
// Count : DWORD* out -> Pointer<Uint32>
// Credential : CREDENTIALW*** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CredEnumerateW(
  Filter: PWideChar;   // LPCWSTR optional
  Flags: DWORD;   // CRED_ENUMERATE_FLAGS optional
  Count: Pointer;   // DWORD* out
  Credential: Pointer   // CREDENTIALW*** out
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CredEnumerateW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CredEnumerateW"
  c_CredEnumerateW :: CWString -> Word32 -> Ptr Word32 -> Ptr () -> IO CInt
-- Filter : LPCWSTR optional -> CWString
-- Flags : CRED_ENUMERATE_FLAGS optional -> Word32
-- Count : DWORD* out -> Ptr Word32
-- Credential : CREDENTIALW*** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let credenumeratew =
  foreign "CredEnumerateW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* Filter : LPCWSTR optional -> (ptr uint16_t) *)
(* Flags : CRED_ENUMERATE_FLAGS optional -> uint32_t *)
(* Count : DWORD* out -> (ptr uint32_t) *)
(* Credential : CREDENTIALW*** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("CredEnumerateW" cred-enumerate-w :convention :stdcall) :int32
  (filter (:string :encoding :utf-16le))   ; LPCWSTR optional
  (flags :uint32)   ; CRED_ENUMERATE_FLAGS optional
  (count :pointer)   ; DWORD* out
  (credential :pointer))   ; CREDENTIALW*** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CredEnumerateW = Win32::API::More->new('ADVAPI32',
    'BOOL CredEnumerateW(LPCWSTR Filter, DWORD Flags, LPVOID Count, LPVOID Credential)');
# my $ret = $CredEnumerateW->Call($Filter, $Flags, $Count, $Credential);
# Filter : LPCWSTR optional -> LPCWSTR
# Flags : CRED_ENUMERATE_FLAGS optional -> DWORD
# Count : DWORD* out -> LPVOID
# Credential : CREDENTIALW*** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型