ホーム › Security.Credentials › CredMarshalCredentialW

CredMarshalCredentialW

関数

資格情報を文字列形式にマーシャリングする。

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

シグネチャ

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

BOOL CredMarshalCredentialW(
    CRED_MARSHAL_TYPE CredType,
    void* Credential,
    LPWSTR* MarshaledCredential
);

パラメーター

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

名前

型

方向

説明

CredType

CRED_MARSHAL_TYPE

マーシャリングする資格情報の種類です。

Credential

void*

マーシャリングする資格情報です。

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

CredType が CertCredential の場合、Credential は CERT_CREDENTIAL_INFO 構造体を指します。

CredType が UsernameTargetCredential の場合、Credential は USERNAME_TARGET_CREDENTIAL_INFO 構造体を指します。

MarshaledCredential

LPWSTR*

out

マーシャリングされた資格情報を格納する null 終端文字列へのポインターです。呼び出し元は、返されたバッファーを CredFree を使用して解放する必要があります。

戻り値の型: BOOL

公式ドキュメント

CredMarshalCredential 関数は、資格情報をテキスト文字列に変換します。(Unicode)

戻り値

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

ERROR_INVALID_PARAMETER

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

解説(Remarks)

メモ

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

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

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "advapi32")]
extern "system" {
    fn CredMarshalCredentialW(
        CredType: i32,  // CRED_MARSHAL_TYPE
        Credential: *mut (),  // void*
        MarshaledCredential: *mut *mut u16  // LPWSTR* 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 CredMarshalCredentialW(int CredType, IntPtr Credential, IntPtr MarshaledCredential);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredMarshalCredentialW' -Namespace Win32 -PassThru
# $api::CredMarshalCredentialW(CredType, Credential, MarshaledCredential)

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

出力引数:

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