Win32 API 日本語リファレンス
ホーム › Media.MediaFoundation › IMFNetCredential

IMFNetCredential

COM
📘 Microsoft Learn (日本語) · English
IID5b87ef6a-7ed8-434f-ba0e-184fac1628d1継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

認証を目的として、ユーザー名およびパスワードの情報を設定・取得します。

メソッド 5

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT SetUser(BYTE* pbData, DWORD cbData, BOOL fDataIsEncrypted)

ユーザー名を設定します。

pbDataBYTE*inユーザー名を格納したバッファへのポインター。fDataIsEncrypted が FALSE の場合、このバッファはワイド文字列です。それ以外の場合、このバッファには暗号化されたデータが格納されます。
cbDataDWORDinpbData のサイズ(バイト単位)。fDataIsEncrypted が FALSE の場合、このサイズには終端の null 文字が含まれます。
fDataIsEncryptedBOOLinTRUE の場合、ユーザー名は暗号化されています。それ以外の場合、ユーザー名は暗号化されていません。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。
vtbl 4 HRESULT SetPassword(BYTE* pbData, DWORD cbData, BOOL fDataIsEncrypted)

パスワードを設定します。

pbDataBYTE*inパスワードを格納したバッファへのポインター。fDataIsEncrypted が FALSE の場合、このバッファはワイド文字列です。それ以外の場合、このバッファには暗号化されたデータが格納されます。
cbDataDWORDinpbData のサイズ(バイト単位)。fDataIsEncrypted が FALSE の場合、このサイズには終端の null 文字が含まれます。
fDataIsEncryptedBOOLinTRUE の場合、パスワードは暗号化されています。それ以外の場合、パスワードは暗号化されていません。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。
vtbl 5 HRESULT GetUser(BYTE* pbData, DWORD* pcbData, BOOL fEncryptData)

ユーザー名を取得します。

pbDataBYTE*outoptionalユーザー名を受け取るバッファへのポインター。必要なバッファサイズを求めるには、このパラメーターを NULL に設定します。fEncryptData が FALSE の場合、このバッファにはワイド文字列が格納されます。それ以外の場合、このバッファには暗号化されたデータが格納されます。
pcbDataDWORD*inout入力時には、pbData バッファのサイズ(バイト単位)を指定します。出力時には、必要なバッファサイズを受け取ります。fEncryptData が FALSE の場合、このサイズには終端の null 文字が含まれます。
fEncryptDataBOOLinTRUE の場合、このメソッドは暗号化された文字列を返します。それ以外の場合、このメソッドは暗号化されていない文字列を返します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。

解説(Remarks)

ユーザー名が利用できない場合でも、このメソッドは成功し、*pcbData をゼロに設定することがあります。

vtbl 6 HRESULT GetPassword(BYTE* pbData, DWORD* pcbData, BOOL fEncryptData)

パスワードを取得します。

pbDataBYTE*outoptionalパスワードを受け取るバッファへのポインター。必要なバッファサイズを求めるには、このパラメーターを NULL に設定します。fEncryptData が FALSE の場合、このバッファにはワイド文字列が格納されます。それ以外の場合、このバッファには暗号化されたデータが格納されます。
pcbDataDWORD*inout入力時には、pbData バッファのサイズ(バイト単位)を指定します。出力時には、必要なバッファサイズを受け取ります。fEncryptData が FALSE の場合、このサイズには終端の null 文字が含まれます。
fEncryptDataBOOLinTRUE の場合、このメソッドは暗号化された文字列を返します。それ以外の場合、このメソッドは暗号化されていない文字列を返します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。

解説(Remarks)

パスワードが利用できない場合でも、このメソッドは成功し、*pcbData をゼロに設定することがあります。

vtbl 7 HRESULT LoggedOnUser(BOOL* pfLoggedOnUser)

ログオン中の資格情報を使用すべきかどうかを照会します。

pfLoggedOnUserBOOL*outブール値を受け取ります。ログオン中の資格情報を使用すべき場合、値は TRUE になります。それ以外の場合、値は FALSE になります。

戻り値

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
 メソッドは成功しました。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IMFNetCredential "{5B87EF6A-7ED8-434F-BA0E-184FAC1628D1}"
#usecom global IMFNetCredential IID_IMFNetCredential "{}"
#comfunc global IMFNetCredential_SetUser       3 var,int,int
#comfunc global IMFNetCredential_SetPassword   4 var,int,int
#comfunc global IMFNetCredential_GetUser       5 var,var,int
#comfunc global IMFNetCredential_GetPassword   6 var,var,int
#comfunc global IMFNetCredential_LoggedOnUser  7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。