CredWriteA

関数

資格情報を資格情報マネージャーに保存する。

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

シグネチャ

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

BOOL CredWriteA(
    CREDENTIALA* Credential,
    DWORD Flags
);

パラメーター

名前

型

方向

説明

Credential

CREDENTIALA*

書き込む CREDENTIAL 構造体へのポインターです。

Flags

DWORD

関数の動作を制御するフラグです。次のフラグが定義されています。

値	意味
CRED_PRESERVE_CREDENTIAL_BLOB	同じ資格情報名および資格情報の種類を持つ既存の資格情報の credential BLOB が保持されます。渡される Credential 構造体の CredentialBlobSize は 0 でなければなりません。

戻り値の型: BOOL

公式ドキュメント

ユーザーの資格情報セットに新しい資格情報を作成するか、既存の資格情報を変更します。(ANSI)

戻り値

関数が成功した場合は TRUE を返します。

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

CRED_TYPE_CERTIFICATE 資格情報を書き込む際には、その他のスマートカード関連のエラーが返されることがあります。

戻り値/値	説明
ERROR_NO_SUCH_LOGON_SESSION	ログオンセッションが存在しないか、このログオンセッションに関連付けられた資格情報セットがありません。ネットワークログオンセッションには、関連付けられた資格情報セットがありません。
ERROR_INVALID_PARAMETER	既存の資格情報では変更できないフィールドがあります。フィールドが既存の資格情報の保護されたフィールドの値と一致しない場合、このエラーが返されます。
ERROR_INVALID_FLAGS	Flags パラメーターに無効な値が指定されました。
ERROR_BAD_USERNAME	渡された Credential 構造体の UserName メンバーが無効です。有効なユーザー名の構文の説明については、そのメンバーの定義を参照してください。
ERROR_NOT_FOUND	CRED_PRESERVE_CREDENTIAL_BLOB が指定されましたが、同じ TargetName および Type を持つ既存の資格情報がありません。
SCARD_E_NO_READERS_AVAILABLE	書き込もうとしている CRED_TYPE_CERTIFICATE 資格情報には、スマートカードリーダーが利用可能である必要があります。
SCARD_E_NO_SMARTCARD or SCARD_W_REMOVED_CARD	書き込もうとしている CRED_TYPE_CERTIFICATE 資格情報には、スマートカードが挿入されている必要があります。
SCARD_W_WRONG_CHV	書き込もうとしている CRED_TYPE_CERTIFICATE 資格情報に対して、誤った PIN が指定されました。

解説(Remarks)

この関数は、指定された TargetName および Type を持つ資格情報が存在しない場合に、資格情報を作成します。指定された TargetName および Type を持つ資格情報が存在する場合は、新しく指定された資格情報が既存のものを置き換えます。

この関数が CRED_TYPE_CERTIFICATE 資格情報を書き込む場合、Credential->CredentialBlob メンバーは、Credential->UserName メンバーで指定された証明書の秘密キーを保護する PIN を指定します。資格情報マネージャーは PIN を保持しません。代わりに、PIN は証明書に示された cryptographic service provider(CSP)に渡され、後で CSP および認証パッケージによって使用されます。PIN の有効期間は CSP が定義します。ほとんどの CSP は、スマートカードがスマートカードリーダーから取り外されたときに PIN をフラッシュします。

Credential パラメーターで指定された CREDENTIAL 構造体の Type メンバーの値が CRED_TYPE_DOMAIN_EXTENDED の場合、ターゲット名に名前空間を指定する必要があります。この関数は、ワイルドカードを含むターゲット名への書き込みをサポートしていません。

メモ

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

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CredWriteA(
    IntPtr Credential,   // CREDENTIALA*
    uint Flags   // DWORD
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredWriteA(
    Credential As IntPtr,   ' CREDENTIALA*
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Credential : CREDENTIALA*
' Flags : DWORD
Declare PtrSafe Function CredWriteA Lib "advapi32" ( _
    ByVal Credential As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredWriteA = ctypes.windll.advapi32.CredWriteA
CredWriteA.restype = wintypes.BOOL
CredWriteA.argtypes = [
    ctypes.c_void_p,  # Credential : CREDENTIALA*
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredWriteA = Fiddle::Function.new(
  lib['CredWriteA'],
  [
    Fiddle::TYPE_VOIDP,  # Credential : CREDENTIALA*
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CredWriteA(
        Credential: *mut CREDENTIALA,  // CREDENTIALA*
        Flags: u32  // DWORD
    ) -> 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 CredWriteA(IntPtr Credential, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredWriteA' -Namespace Win32 -PassThru
# $api::CredWriteA(Credential, Flags)

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

出力引数:

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