ホーム › Security.Credentials › CredUnmarshalCredentialW

CredUnmarshalCredentialW

関数

マーシャリングされた資格情報を元の形式に復元する。

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

シグネチャ

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

BOOL CredUnmarshalCredentialW(
    LPCWSTR MarshaledCredential,
    CRED_MARSHAL_TYPE* CredType,
    void** Credential
);

パラメーター

名前	型	方向	説明
MarshaledCredential	LPCWSTR	in	マーシャリングされた資格情報を含む、null で終わる文字列へのポインターです。
CredType	CRED_MARSHAL_TYPE*	out	MarshaledCredential で指定された資格情報の種類です。これは CRED_MARSHAL_TYPE 値のいずれかです。
Credential	void**	out	アンマーシャリングされた資格情報へのポインターです。CredType が CertCredential を返す場合、返されるポインターは CERT_CREDENTIAL_INFO 構造体を指します。CredType が UsernameTargetCredential を返す場合、返されるポインターは USERNAME_TARGET_CREDENTIAL_INFO 構造体を指します。呼び出し元は、CredFree を使用して、返されたバッファーを解放する必要があります。

名前

型

方向

説明

MarshaledCredential

LPCWSTR

マーシャリングされた資格情報を含む、null で終わる文字列へのポインターです。

CredType

CRED_MARSHAL_TYPE*

out

MarshaledCredential で指定された資格情報の種類です。

これは CRED_MARSHAL_TYPE 値のいずれかです。

Credential

void**

out

アンマーシャリングされた資格情報へのポインターです。CredType が CertCredential を返す場合、返されるポインターは CERT_CREDENTIAL_INFO 構造体を指します。CredType が UsernameTargetCredential を返す場合、返されるポインターは USERNAME_TARGET_CREDENTIAL_INFO 構造体を指します。

呼び出し元は、CredFree を使用して、返されたバッファーを解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

CredUnmarshalCredential 関数は、マーシャリングされた資格情報を元の形式に変換し直します。(Unicode)

戻り値

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

ERROR_INVALID_PARAMETER

MarshaledCredential が有効ではありません。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CredUnmarshalCredentialW(
    LPCWSTR MarshaledCredential,
    CRED_MARSHAL_TYPE* CredType,
    void** Credential
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredUnmarshalCredentialW(
    [MarshalAs(UnmanagedType.LPWStr)] string MarshaledCredential,   // LPCWSTR
    out int CredType,   // CRED_MARSHAL_TYPE* out
    IntPtr Credential   // void** out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredUnmarshalCredentialW(
    <MarshalAs(UnmanagedType.LPWStr)> MarshaledCredential As String,   ' LPCWSTR
    <Out> ByRef CredType As Integer,   ' CRED_MARSHAL_TYPE* out
    Credential As IntPtr   ' void** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' MarshaledCredential : LPCWSTR
' CredType : CRED_MARSHAL_TYPE* out
' Credential : void** out
Declare PtrSafe Function CredUnmarshalCredentialW Lib "advapi32" ( _
    ByVal MarshaledCredential As LongPtr, _
    ByRef CredType As Long, _
    ByVal Credential As LongPtr) 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

CredUnmarshalCredentialW = ctypes.windll.advapi32.CredUnmarshalCredentialW
CredUnmarshalCredentialW.restype = wintypes.BOOL
CredUnmarshalCredentialW.argtypes = [
    wintypes.LPCWSTR,  # MarshaledCredential : LPCWSTR
    ctypes.c_void_p,  # CredType : CRED_MARSHAL_TYPE* out
    ctypes.c_void_p,  # Credential : void** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredUnmarshalCredentialW = Fiddle::Function.new(
  lib['CredUnmarshalCredentialW'],
  [
    Fiddle::TYPE_VOIDP,  # MarshaledCredential : LPCWSTR
    Fiddle::TYPE_VOIDP,  # CredType : CRED_MARSHAL_TYPE* out
    Fiddle::TYPE_VOIDP,  # Credential : void** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn CredUnmarshalCredentialW(
        MarshaledCredential: *const u16,  // LPCWSTR
        CredType: *mut i32,  // CRED_MARSHAL_TYPE* out
        Credential: *mut *mut ()  // void** out
    ) -> 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 CredUnmarshalCredentialW([MarshalAs(UnmanagedType.LPWStr)] string MarshaledCredential, out int CredType, IntPtr Credential);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredUnmarshalCredentialW' -Namespace Win32 -PassThru
# $api::CredUnmarshalCredentialW(MarshaledCredential, CredType, Credential)

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

出力引数:

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