ホーム › Security.Credentials › CredWriteDomainCredentialsW

CredWriteDomainCredentialsW

関数

対象情報を指定してドメイン資格情報を保存する。

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

シグネチャ

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

BOOL CredWriteDomainCredentialsW(
    CREDENTIAL_TARGET_INFORMATIONW* TargetInfo,
    CREDENTIALW* Credential,
    DWORD Flags
);

パラメーター

名前

型

方向

説明

TargetInfo

CREDENTIAL_TARGET_INFORMATIONW*

対象サーバーを識別します。命名メンバーの少なくとも 1 つは非 NULL である必要があり、NetbiosServerName、DnsServerName、NetbiosDomainName、DnsDomainName、または DnsTreeName を指定できます。

Credential

CREDENTIALW*

書き込む資格情報。

この資格情報は TargetInfo と一致するものである必要があります。たとえば、TargetName がワイルドカード DNS 名である場合、資格情報の TargetName メンバーは TargetInfo の DnsServerName メンバーの後置部分(postfix)である必要があります。

Flags

DWORD

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

Value	Meaning
CRED_PRESERVE_CREDENTIAL_BLOB	資格情報 BLOB は、同じ資格情報名および資格情報の種類を持つ既存の資格情報から保持されます。渡される Credential 構造体の CredentialBlobSize はゼロである必要があります。

戻り値の型: BOOL

公式ドキュメント

ユーザーの資格情報セットにドメイン資格情報を書き込みます。(Unicode)

戻り値

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

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

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

Return code	Description
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。命名パラメーターが 1 つも指定されていない、指定された資格情報の Type メンバーが CRED_TYPE_DOMAIN_PASSWORD または CRED_TYPE_DOMAIN_CERTIFICATE に設定されていない、あるいは Credential が TargetInfo と一致しない、のいずれかです。
ERROR_NO_SUCH_LOGON_SESSION	ログオンセッションが存在しないか、このログオンセッションに関連付けられた資格情報セットがありません。ネットワークログオンセッションには、関連付けられた資格情報セットがありません。
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: The CRED_TYPE_CERTIFICATE	書き込もうとしている資格情報には、スマートカードが挿入されている必要があります。
SCARD_W_WRONG_CHV	書き込もうとしている CRED_TYPE_CERTIFICATE 資格情報に対して、誤った PIN が指定されました。

解説(Remarks)

この関数が CRED_TYPE_CERTIFICATE 資格情報を書き込む場合、Credential->CredentialBlob メンバーは、Credential->UserName で指定された証明書の秘密鍵を保護する PIN を指定します。資格情報マネージャーは PIN を保持しません。PIN は、後で CSP および認証パッケージが使用できるよう、証明書の CSP に渡されます。PIN の有効期間は CSP が定義します。たとえば、ほとんどの CSP はスマートカードが取り外されると PIN を破棄します。

CredWriteDomainCredentials は、ドメイン(CRED_TYPE_DOMAIN_PASSWORD または CRED_TYPE_DOMAIN_CERTIFICATE)資格情報特有の事情を扱う点で CredWrite と異なります。ドメイン資格情報には、複数の対象メンバーが含まれます。

Credential パラメーターで指定された CREDENTIAL 構造体の Type メンバーの値が CRED_TYPE_DOMAIN_EXTENDED である場合、対象名に名前空間を指定する必要があります。

メモ

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

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

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

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

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

CredWriteDomainCredentialsW = ctypes.windll.advapi32.CredWriteDomainCredentialsW
CredWriteDomainCredentialsW.restype = wintypes.BOOL
CredWriteDomainCredentialsW.argtypes = [
    ctypes.c_void_p,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONW*
    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')
CredWriteDomainCredentialsW = Fiddle::Function.new(
  lib['CredWriteDomainCredentialsW'],
  [
    Fiddle::TYPE_VOIDP,  # TargetInfo : CREDENTIAL_TARGET_INFORMATIONW*
    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 CredWriteDomainCredentialsW(
        TargetInfo: *mut CREDENTIAL_TARGET_INFORMATIONW,  // CREDENTIAL_TARGET_INFORMATIONW*
        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 CredWriteDomainCredentialsW(IntPtr TargetInfo, IntPtr Credential, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredWriteDomainCredentialsW' -Namespace Win32 -PassThru
# $api::CredWriteDomainCredentialsW(TargetInfo, Credential, Flags)

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

出力引数:

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