ホーム › Security.Credentials › CredFindBestCredentialW

CredFindBestCredentialW

関数

対象名に最も適した資格情報を検索して取得する。

DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL CredFindBestCredentialW(
    LPCWSTR TargetName,
    DWORD Type,
    DWORD Flags,
    CREDENTIALW** Credential
);

パラメーター

名前	型	方向	説明
TargetName	LPCWSTR	in	資格情報を検索する対象のターゲットリソース名を格納した、null 終端文字列へのポインター。
Type	DWORD	in	検索する資格情報の種類。現在、この関数は CRED_TYPE_GENERIC のみをサポートします。
Flags	DWORD	in	予約済みです。
Credential	CREDENTIALW**	out	この関数が取得した資格情報の組を指定する CREDENTIAL 構造体へのポインターのアドレス。この構造体の使用を終えたら、CredFree 関数を呼び出して解放してください。

戻り値の型: BOOL

公式ドキュメント

資格情報管理 (CredMan) データベースを検索し、現在のログオンセッションに関連付けられた汎用資格情報のうち、指定したターゲットリソースに最も一致するものの組を取得します。(Unicode)

戻り値

関数が成功すると、TRUE を返します。

関数が失敗すると、FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CredFindBestCredentialW(
    LPCWSTR TargetName,
    DWORD Type,
    DWORD Flags,
    CREDENTIALW** Credential
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredFindBestCredentialW(
    [MarshalAs(UnmanagedType.LPWStr)] string TargetName,   // LPCWSTR
    uint Type,   // DWORD
    uint Flags,   // DWORD
    IntPtr Credential   // CREDENTIALW** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredFindBestCredentialW(
    <MarshalAs(UnmanagedType.LPWStr)> TargetName As String,   ' LPCWSTR
    Type As UInteger,   ' DWORD
    Flags As UInteger,   ' DWORD
    Credential As IntPtr   ' CREDENTIALW** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' TargetName : LPCWSTR
' Type : DWORD
' Flags : DWORD
' Credential : CREDENTIALW** out
Declare PtrSafe Function CredFindBestCredentialW Lib "advapi32" ( _
    ByVal TargetName As LongPtr, _
    ByVal Type As Long, _
    ByVal Flags 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

CredFindBestCredentialW = ctypes.windll.advapi32.CredFindBestCredentialW
CredFindBestCredentialW.restype = wintypes.BOOL
CredFindBestCredentialW.argtypes = [
    wintypes.LPCWSTR,  # TargetName : LPCWSTR
    wintypes.DWORD,  # Type : DWORD
    wintypes.DWORD,  # Flags : DWORD
    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')
CredFindBestCredentialW = Fiddle::Function.new(
  lib['CredFindBestCredentialW'],
  [
    Fiddle::TYPE_VOIDP,  # TargetName : LPCWSTR
    -Fiddle::TYPE_INT,  # Type : DWORD
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Credential : CREDENTIALW** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CredFindBestCredentialW(
        TargetName: *const u16,  // LPCWSTR
        Type: u32,  // DWORD
        Flags: u32,  // DWORD
        Credential: *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 CredFindBestCredentialW([MarshalAs(UnmanagedType.LPWStr)] string TargetName, uint Type, uint Flags, IntPtr Credential);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredFindBestCredentialW' -Namespace Win32 -PassThru
# $api::CredFindBestCredentialW(TargetName, Type, Flags, Credential)

#uselib "ADVAPI32.dll"
#func global CredFindBestCredentialW "CredFindBestCredentialW" wptr, wptr, wptr, wptr
; CredFindBestCredentialW TargetName, Type, Flags, varptr(Credential)   ; 戻り値は stat
; TargetName : LPCWSTR -> "wptr"
; Type : DWORD -> "wptr"
; Flags : DWORD -> "wptr"
; Credential : CREDENTIALW** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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