CredWriteW

関数

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

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

シグネチャ

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

BOOL CredWriteW(
    CREDENTIALW* Credential,
    DWORD Flags
);

パラメーター

名前

型

方向

説明

Credential

CREDENTIALW*

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

Flags

DWORD

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、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 は証明書に示された暗号化サービスプロバイダー (CSP) に渡され、その後 CSP および認証パッケージによって使用されます。PIN の有効期間は CSP が定義します。ほとんどの CSP は、スマートカードがスマートカードリーダーから取り外されると PIN を破棄します。

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

メモ

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

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

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

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

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

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

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

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

出力引数:

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