credWriteDomainCredentialsA 函式 (wincred.h)
CredWriteDomainCredentials 函式會將網域認證寫入使用者的認證集。 使用的認證集是與目前權杖登入會話相關聯的認證集。 權杖不得停用使用者的 SID。
語法
BOOL CredWriteDomainCredentialsA(
[in] PCREDENTIAL_TARGET_INFORMATIONA TargetInfo,
[in] PCREDENTIALA Credential,
[in] DWORD Flags
);
參數
[in] TargetInfo
識別目標伺服器。 至少有一個命名成員必須是非Null,而且可以是NetbiosServerName、DnsServerName、NetbiosDomainName、DnsDomainName或DnsTreeName。
[in] Credential
要寫入的認證。
認證必須是符合TargetInfo的認證。例如,如果TargetName是萬用字元 DNS 名稱,則認證的TargetName成員必須是TargetInfo中DnsServerName成員的後置詞。
[in] Flags
用來控制 API 作業的旗標。 已定義下列旗標。
值 | 意義 |
---|---|
|
應該從具有相同認證名稱和認證類型的現有認證保留認證 BLOB。 在Credential結構中傳遞之 的CredentialBlobSize必須是零。 |
傳回值
如果函式成功,函式會傳回 TRUE。
如果函式失敗,則會傳回 FALSE。 呼叫 GetLastError 函 式以取得更明確的狀態碼。 可以傳回下列狀態碼。
撰寫CRED_TYPE_CERTIFICATE認證時,可以傳回其他智慧卡錯誤。
傳回碼 | 描述 |
---|---|
|
一或多個參數無效。 未指定任何具名引數,或指定的認證未將 Type 成員設定為 CRED_TYPE_DOMAIN_PASSWORD 或 CRED_TYPE_DOMAIN_CERTIFICATE,或 認證 不符合 TargetInfo。 |
|
登入會話不存在,或沒有與此登入會話相關聯的認證集。 網路登入會話沒有相關聯的認證集。 |
|
已為 Flags 參數指定不正確值。 |
|
傳入認證結構之 的UserName成員無效。 如需有效語法的描述,請參閱該成員的定義。 |
|
CRED_PRESERVE_CREDENTIAL_BLOB已指定,而且沒有相同 TargetName 和 Type的現有認證。 |
|
要寫入的CRED_TYPE_CERTIFICATE認證需要智慧卡閱讀機才能使用。 |
|
要寫入的認證需要插入智慧卡。 |
|
針對正在寫入的CRED_TYPE_CERTIFICATE認證,提供了錯誤的 PIN 碼。 |
備註
當此函式寫入CRED_TYPE_CERTIFICATE認證時,Credential-CredentialBlob> 成員會指定 PIN 來保護Credential-UserName> 所指定憑證的私密金鑰。 認證管理員不會維護 PIN。 相反地,PIN 會傳遞至憑證的 CSP,以供 CSP 和驗證套件稍後使用。 CSP 會定義 PIN 的存留期。 例如,大部分 CSP 會在智慧卡移除時排清 PIN。
CredWriteDomainCredentials 與 CredWrite 不同,因為它會處理網域 (CRED_TYPE_DOMAIN_PASSWORD 或CRED_TYPE_DOMAIN_CERTIFICATE) 認證的 idiosyncrasies。 網域認證包含多個目標成員。
如果Credential參數所指定CREDENTIAL結構的Type成員值CRED_TYPE_DOMAIN_EXTENDED,則必須在目標名稱中指定命名空間。
注意
wincred.h 標頭會根據 UNICODE 預處理器常數的定義,將 CredWriteDomainCredentials 定義為別名,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼,可能會導致編譯或執行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | wincred.h |
程式庫 | Advapi32.lib |
Dll | Advapi32.dll |