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

CredUIConfirmCredentialsA

関数
入力された資格情報の有効性を確認し保存可否を確定する。
DLLcredui.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD CredUIConfirmCredentialsA(
    LPCSTR pszTargetName,
    BOOL bConfirm
);

パラメーター

名前方向説明
pszTargetNameLPCSTRin資格情報の対象の名前(通常はドメインまたはサーバーアプリケーション名)を格納する null で終わる文字列へのポインターです。これは CredUIPromptForCredentials または CredUICmdLinePromptForCredentialspszTargetName として渡された値と同じである必要があります。
bConfirmBOOLinプロンプト関数から返された資格情報が有効かどうかを指定します。TRUE の場合、資格情報は CredUIPromptForCredentials または CredUICmdLinePromptForCredentials で定義されたとおりに資格情報マネージャーに保存されます。FALSE の場合、資格情報は保存されず、各種メモリが解放されます。

戻り値の型: DWORD

公式ドキュメント

CredUIPromptForCredentials または CredUICmdLinePromptForCredentials の後に呼び出され、取得した資格情報の有効性を確認します。(ANSI)

戻り値

操作のステータスが返されます。呼び出し元はこのステータスを確認して、資格情報の確認操作が成功したかどうかを判断できます。ほとんどのアプリケーションは、リソースへの接続が既に完了しているため、このステータスコードを無視します。資格情報が確認待ちの資格情報リストに見つからなかった場合、または資格情報の書き込みもしくは削除の試行が失敗した場合に、操作が失敗することがあります。リストに資格情報が見つからないのは、その資格情報がキューに登録されなかったか、キューに登録された資格情報が多すぎたことが原因で発生する可能性があります。最大 5 件の資格情報をキューに登録でき、新しいものがキューに登録されると古いものが破棄されます。

戻り値 説明
NO_ERROR - (zero)
確認操作が成功しました。
ERROR_NOT_FOUND
対象の資格情報が確認待機リストに見つかりませんでした。
ERROR_INVALID_PARAMETER
資格情報に無効なデータまたは不整合なデータが含まれていたため、待機中の資格情報の確認の試行が失敗しました。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

DWORD CredUIConfirmCredentialsA(
    LPCSTR pszTargetName,
    BOOL bConfirm
);
[DllImport("credui.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CredUIConfirmCredentialsA(
    [MarshalAs(UnmanagedType.LPStr)] string pszTargetName,   // LPCSTR
    bool bConfirm   // BOOL
);
<DllImport("credui.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CredUIConfirmCredentialsA(
    <MarshalAs(UnmanagedType.LPStr)> pszTargetName As String,   ' LPCSTR
    bConfirm As Boolean   ' BOOL
) As UInteger
End Function
' pszTargetName : LPCSTR
' bConfirm : BOOL
Declare PtrSafe Function CredUIConfirmCredentialsA Lib "credui" ( _
    ByVal pszTargetName As String, _
    ByVal bConfirm As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CredUIConfirmCredentialsA = ctypes.windll.credui.CredUIConfirmCredentialsA
CredUIConfirmCredentialsA.restype = wintypes.DWORD
CredUIConfirmCredentialsA.argtypes = [
    wintypes.LPCSTR,  # pszTargetName : LPCSTR
    wintypes.BOOL,  # bConfirm : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('credui.dll')
CredUIConfirmCredentialsA = Fiddle::Function.new(
  lib['CredUIConfirmCredentialsA'],
  [
    Fiddle::TYPE_VOIDP,  # pszTargetName : LPCSTR
    Fiddle::TYPE_INT,  # bConfirm : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "credui")]
extern "system" {
    fn CredUIConfirmCredentialsA(
        pszTargetName: *const u8,  // LPCSTR
        bConfirm: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("credui.dll", CharSet = CharSet.Ansi)]
public static extern uint CredUIConfirmCredentialsA([MarshalAs(UnmanagedType.LPStr)] string pszTargetName, bool bConfirm);
"@
$api = Add-Type -MemberDefinition $sig -Name 'credui_CredUIConfirmCredentialsA' -Namespace Win32 -PassThru
# $api::CredUIConfirmCredentialsA(pszTargetName, bConfirm)
#uselib "credui.dll"
#func global CredUIConfirmCredentialsA "CredUIConfirmCredentialsA" sptr, sptr
; CredUIConfirmCredentialsA pszTargetName, bConfirm   ; 戻り値は stat
; pszTargetName : LPCSTR -> "sptr"
; bConfirm : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "credui.dll"
#cfunc global CredUIConfirmCredentialsA "CredUIConfirmCredentialsA" str, int
; res = CredUIConfirmCredentialsA(pszTargetName, bConfirm)
; pszTargetName : LPCSTR -> "str"
; bConfirm : BOOL -> "int"
; DWORD CredUIConfirmCredentialsA(LPCSTR pszTargetName, BOOL bConfirm)
#uselib "credui.dll"
#cfunc global CredUIConfirmCredentialsA "CredUIConfirmCredentialsA" str, int
; res = CredUIConfirmCredentialsA(pszTargetName, bConfirm)
; pszTargetName : LPCSTR -> "str"
; bConfirm : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	credui = windows.NewLazySystemDLL("credui.dll")
	procCredUIConfirmCredentialsA = credui.NewProc("CredUIConfirmCredentialsA")
)

// pszTargetName (LPCSTR), bConfirm (BOOL)
r1, _, err := procCredUIConfirmCredentialsA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszTargetName))),
	uintptr(bConfirm),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function CredUIConfirmCredentialsA(
  pszTargetName: PAnsiChar;   // LPCSTR
  bConfirm: BOOL   // BOOL
): DWORD; stdcall;
  external 'credui.dll' name 'CredUIConfirmCredentialsA';
result := DllCall("credui\CredUIConfirmCredentialsA"
    , "AStr", pszTargetName   ; LPCSTR
    , "Int", bConfirm   ; BOOL
    , "UInt")   ; return: DWORD
●CredUIConfirmCredentialsA(pszTargetName, bConfirm) = DLL("credui.dll", "dword CredUIConfirmCredentialsA(char*, bool)")
# 呼び出し: CredUIConfirmCredentialsA(pszTargetName, bConfirm)
# pszTargetName : LPCSTR -> "char*"
# bConfirm : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "credui" fn CredUIConfirmCredentialsA(
    pszTargetName: [*c]const u8, // LPCSTR
    bConfirm: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc CredUIConfirmCredentialsA(
    pszTargetName: cstring,  # LPCSTR
    bConfirm: int32  # BOOL
): uint32 {.importc: "CredUIConfirmCredentialsA", stdcall, dynlib: "credui.dll".}
pragma(lib, "credui");
extern(Windows)
uint CredUIConfirmCredentialsA(
    const(char)* pszTargetName,   // LPCSTR
    int bConfirm   // BOOL
);
ccall((:CredUIConfirmCredentialsA, "credui.dll"), stdcall, UInt32,
      (Cstring, Int32),
      pszTargetName, bConfirm)
# pszTargetName : LPCSTR -> Cstring
# bConfirm : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t CredUIConfirmCredentialsA(
    const char* pszTargetName,
    int32_t bConfirm);
]]
local credui = ffi.load("credui")
-- credui.CredUIConfirmCredentialsA(pszTargetName, bConfirm)
-- pszTargetName : LPCSTR
-- bConfirm : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('credui.dll');
const CredUIConfirmCredentialsA = lib.func('__stdcall', 'CredUIConfirmCredentialsA', 'uint32_t', ['str', 'int32_t']);
// CredUIConfirmCredentialsA(pszTargetName, bConfirm)
// pszTargetName : LPCSTR -> 'str'
// bConfirm : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("credui.dll", {
  CredUIConfirmCredentialsA: { parameters: ["buffer", "i32"], result: "u32" },
});
// lib.symbols.CredUIConfirmCredentialsA(pszTargetName, bConfirm)
// pszTargetName : LPCSTR -> "buffer"
// bConfirm : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t CredUIConfirmCredentialsA(
    const char* pszTargetName,
    int32_t bConfirm);
C, "credui.dll");
// $ffi->CredUIConfirmCredentialsA(pszTargetName, bConfirm);
// pszTargetName : LPCSTR
// bConfirm : BOOL
// 構造体/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 Credui extends StdCallLibrary {
    Credui INSTANCE = Native.load("credui", Credui.class, W32APIOptions.ASCII_OPTIONS);
    int CredUIConfirmCredentialsA(
        String pszTargetName,   // LPCSTR
        boolean bConfirm   // BOOL
    );
}
@[Link("credui")]
lib Libcredui
  fun CredUIConfirmCredentialsA = CredUIConfirmCredentialsA(
    pszTargetName : UInt8*,   # LPCSTR
    bConfirm : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CredUIConfirmCredentialsANative = Uint32 Function(Pointer<Utf8>, Int32);
typedef CredUIConfirmCredentialsADart = int Function(Pointer<Utf8>, int);
final CredUIConfirmCredentialsA = DynamicLibrary.open('credui.dll')
    .lookupFunction<CredUIConfirmCredentialsANative, CredUIConfirmCredentialsADart>('CredUIConfirmCredentialsA');
// pszTargetName : LPCSTR -> Pointer<Utf8>
// bConfirm : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CredUIConfirmCredentialsA(
  pszTargetName: PAnsiChar;   // LPCSTR
  bConfirm: BOOL   // BOOL
): DWORD; stdcall;
  external 'credui.dll' name 'CredUIConfirmCredentialsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CredUIConfirmCredentialsA"
  c_CredUIConfirmCredentialsA :: CString -> CInt -> IO Word32
-- pszTargetName : LPCSTR -> CString
-- bConfirm : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let creduiconfirmcredentialsa =
  foreign "CredUIConfirmCredentialsA"
    (string @-> int32_t @-> returning uint32_t)
(* pszTargetName : LPCSTR -> string *)
(* bConfirm : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library credui (t "credui.dll"))
(cffi:use-foreign-library credui)

(cffi:defcfun ("CredUIConfirmCredentialsA" cred-uiconfirm-credentials-a :convention :stdcall) :uint32
  (psz-target-name :string)   ; LPCSTR
  (b-confirm :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CredUIConfirmCredentialsA = Win32::API::More->new('credui',
    'DWORD CredUIConfirmCredentialsA(LPCSTR pszTargetName, BOOL bConfirm)');
# my $ret = $CredUIConfirmCredentialsA->Call($pszTargetName, $bConfirm);
# pszTargetName : LPCSTR -> LPCSTR
# bConfirm : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い