ホーム › Security.Credentials › CredEnumerateA

CredEnumerateA

関数

フィルタに一致する資格情報を列挙する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CredEnumerateA(
    LPCSTR Filter,   // optional
    CRED_ENUMERATE_FLAGS Flags,   // optional
    DWORD* Count,
    CREDENTIALA*** Credential
);

パラメーター

名前

型

方向

説明

Filter

LPCSTR

inoptional

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

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

Flags

CRED_ENUMERATE_FLAGS

optional

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

値

意味

CRED_ENUMERATE_ALL_CREDENTIALS
0x1

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

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

Count

DWORD*

out

Credentials 配列に返される資格情報の数。

Credential

CREDENTIALA***

out

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

戻り値/値	説明
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 を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL CredEnumerateA(
    LPCSTR Filter,   // optional
    CRED_ENUMERATE_FLAGS Flags,   // optional
    DWORD* Count,
    CREDENTIALA*** Credential
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CredEnumerateA(
    [MarshalAs(UnmanagedType.LPStr)] string Filter,   // LPCSTR optional
    uint Flags,   // CRED_ENUMERATE_FLAGS optional
    out uint Count,   // DWORD* out
    IntPtr Credential   // CREDENTIALA*** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredEnumerateA(
    <MarshalAs(UnmanagedType.LPStr)> Filter As String,   ' LPCSTR optional
    Flags As UInteger,   ' CRED_ENUMERATE_FLAGS optional
    <Out> ByRef Count As UInteger,   ' DWORD* out
    Credential As IntPtr   ' CREDENTIALA*** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Filter : LPCSTR optional
' Flags : CRED_ENUMERATE_FLAGS optional
' Count : DWORD* out
' Credential : CREDENTIALA*** out
Declare PtrSafe Function CredEnumerateA Lib "advapi32" ( _
    ByVal Filter As String, _
    ByVal Flags As Long, _
    ByRef Count As Long, _
    ByVal Credential As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredEnumerateA = ctypes.windll.advapi32.CredEnumerateA
CredEnumerateA.restype = wintypes.BOOL
CredEnumerateA.argtypes = [
    wintypes.LPCSTR,  # Filter : LPCSTR optional
    wintypes.DWORD,  # Flags : CRED_ENUMERATE_FLAGS optional
    ctypes.POINTER(wintypes.DWORD),  # Count : DWORD* out
    ctypes.c_void_p,  # Credential : CREDENTIALA*** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredEnumerateA = Fiddle::Function.new(
  lib['CredEnumerateA'],
  [
    Fiddle::TYPE_VOIDP,  # Filter : LPCSTR optional
    -Fiddle::TYPE_INT,  # Flags : CRED_ENUMERATE_FLAGS optional
    Fiddle::TYPE_VOIDP,  # Count : DWORD* out
    Fiddle::TYPE_VOIDP,  # Credential : CREDENTIALA*** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CredEnumerateA(
        Filter: *const u8,  // LPCSTR optional
        Flags: u32,  // CRED_ENUMERATE_FLAGS optional
        Count: *mut u32,  // DWORD* out
        Credential: *mut *mut *mut CREDENTIALA  // CREDENTIALA*** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CredEnumerateA([MarshalAs(UnmanagedType.LPStr)] string Filter, uint Flags, out uint Count, IntPtr Credential);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredEnumerateA' -Namespace Win32 -PassThru
# $api::CredEnumerateA(Filter, Flags, Count, Credential)

#uselib "ADVAPI32.dll"
#func global CredEnumerateA "CredEnumerateA" sptr, sptr, sptr, sptr
; CredEnumerateA Filter, Flags, varptr(Count), varptr(Credential)   ; 戻り値は stat
; Filter : LPCSTR optional -> "sptr"
; Flags : CRED_ENUMERATE_FLAGS optional -> "sptr"
; Count : DWORD* out -> "sptr"
; Credential : CREDENTIALA*** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CredEnumerateA "CredEnumerateA" str, int, var, var
; res = CredEnumerateA(Filter, Flags, Count, Credential)
; Filter : LPCSTR optional -> "str"
; Flags : CRED_ENUMERATE_FLAGS optional -> "int"
; Count : DWORD* out -> "var"
; Credential : CREDENTIALA*** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CredEnumerateA "CredEnumerateA" str, int, sptr, sptr
; res = CredEnumerateA(Filter, Flags, varptr(Count), varptr(Credential))
; Filter : LPCSTR optional -> "str"
; Flags : CRED_ENUMERATE_FLAGS optional -> "int"
; Count : DWORD* out -> "sptr"
; Credential : CREDENTIALA*** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。