CredReadW

関数

対象名と種別を指定して資格情報を読み取る。

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

シグネチャ

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

BOOL CredReadW(
    LPCWSTR TargetName,
    CRED_TYPE Type,
    DWORD Flags,   // optional
    CREDENTIALW** Credential
);

パラメーター

名前	型	方向	説明
TargetName	LPCWSTR	in	読み取る資格情報の名前を格納した、null 終端文字列へのポインター。
Type	CRED_TYPE	in	読み取る資格情報の種類。Type は CRED_TYPE_* で定義された型のいずれかである必要があります。
Flags	DWORD	optional	現在予約されており、ゼロを指定する必要があります。
Credential	CREDENTIALW**	out	資格情報を返すために割り当てられた単一のブロックバッファーへのポインター。バッファー内に含まれるポインターは、この単一の割り当てブロック内の位置を指します。返された単一のバッファーは、CredFree を呼び出して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

ユーザーの資格情報セットから資格情報を読み取ります。(Unicode)

戻り値

この関数は、成功した場合は TRUE を、失敗した場合は FALSE を返します。より具体的なステータスコードを取得するには、GetLastError 関数を呼び出します。次のステータスコードが返される場合があります。

ERROR_NOT_FOUND
指定された TargetName を持つ資格情報が存在しません。
ERROR_NO_SUCH_LOGON_SESSION
ログオンセッションが存在しないか、このログオンセッションに関連付けられた資格情報セットが存在しません。ネットワークログオンセッションには、関連付けられた資格情報セットがありません。
ERROR_INVALID_FLAGS
Flags パラメーターに無効なフラグが指定されました。

解説(Remarks)

Credential パラメーターで指定された CREDENTIAL 構造体の Type メンバーの値が CRED_TYPE_DOMAIN_EXTENDED である場合、ターゲット名に名前空間を指定する必要があります。この関数は、指定された種類の資格情報を 1 つだけ返すことができます。

メモ

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

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

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

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

' TargetName : LPCWSTR
' Type : CRED_TYPE
' Flags : DWORD optional
' Credential : CREDENTIALW** out
Declare PtrSafe Function CredReadW 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

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

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

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

出力引数:

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