Win32 API 日本語リファレンス
ホーム › Security.Authentication.Identity.Provider › IIdentityProvider

IIdentityProvider

COM
📘 Microsoft Learn (日本語) · English
IID0d1b9e0c-e8ba-4f55-a81b-bce934b948f5継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ID プロバイダーを表します。

メソッド 8

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

vtbl 3 HRESULT GetIdentityEnum(IDENTITY_TYPE eIdentityType, PROPERTYKEY* pFilterkey, PROPVARIANT* pFilterPropVarValue, IEnumUnknown** ppIdentityEnum)

ID の列挙に使用できる IEnumUnknown インターフェイス ポインターを取得します。

eIdentityTypeIDENTITY_TYPEin列挙する ID の種類を示す IDENTITY_TYPE 列挙型の値です。
pFilterkeyPROPERTYKEY*inoptionalプロパティを指定するプロパティ キーへのポインターです。このパラメーターの値が NULL でない場合、このパラメーターで指定されたプロパティをサポートする ID のみが列挙されます。
pFilterPropVarValuePROPVARIANT*inoptionalプロパティ値へのポインターです。このパラメーターと pFilterkey パラメーターの値がどちらも NULL でない場合、このパラメーターで指定されたプロパティ値を持つ ID のみが列挙されます。
ppIdentityEnumIEnumUnknown**outID の列挙に使用できる IEnumUnknown インターフェイス ポインターへのポインターです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 4 HRESULT Create(LPWSTR lpszUserName, IPropertyStore** ppPropertyStore, PROPVARIANT* pKeywordsToAdd)

指定されたユーザー名に関連付けられた新しい ID を作成します。

lpszUserNameLPWSTRin新しい ID に関連付けるユーザー名です。
ppPropertyStoreIPropertyStore**out新しい ID に関連付けられたプロパティ ストアを表す IPropertyStore インターフェイスへのポインターです。
pKeywordsToAddPROPVARIANT*in新しい ID に関連付けるプロパティです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 5 HRESULT Import(IPropertyStore* pPropertyStore)

ID をシステムにインポートします。

pPropertyStoreIPropertyStore*inoptionalシステム上に新しい ID を作成するために必要なすべての情報を指定する IPropertyStore インターフェイスへのポインターです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 6 HRESULT Delete(LPWSTR lpszUniqueID, PROPVARIANT* pKeywordsToDelete)

指定された ID を ID ストアから削除するか、指定されたプロパティを ID から削除します。

lpszUniqueIDLPWSTRinID に関連付けられた一意の名前です。
pKeywordsToDeletePROPVARIANT*in削除するプロパティの名前です。このパラメーターの値が NULL の場合、ID そのものが削除されます。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 7 HRESULT FindByUniqueID(LPWSTR lpszUniqueID, IPropertyStore** ppPropertyStore)

指定された ID に関連付けられた IPropertyStore インターフェイス インスタンスへのポインターを取得します。

lpszUniqueIDLPWSTRin検索する一意の ID です。
ppPropertyStoreIPropertyStore**out指定された ID に関連付けられた IPropertyStore インターフェイスのインスタンスへのポインターです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 8 HRESULT GetProviderPropertyStore(IPropertyStore** ppPropertyStore)

ID プロバイダーに関連付けられた IPropertyStore インターフェイスへのポインターを取得します。

ppPropertyStoreIPropertyStore**outこの ID プロバイダーに関連付けられたグローバルな IPropertyStore インターフェイスへのポインターです。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 9 HRESULT Advise(IIdentityAdvise* pIdentityAdvise, DWORD dwIdentityUpdateEvents, DWORD* pdwCookie)

呼び出し元アプリケーションが、通知を受け取る ID イベントの一覧を指定できるようにします。

pIdentityAdviseIIdentityAdvise*inoptional呼び出し元アプリケーションが実装する IIdentityAdvise インターフェイスへのポインターです。このインターフェイスは、dwIdentityUpdateEvents パラメーターで指定されたイベントのいずれかが発生したときに ID プロバイダーが呼び出すことのできるメソッドを提供します。
dwIdentityUpdateEventsDWORDin

呼び出し元アプリケーションが通知を受け取る ID イベントです。このパラメーターの値には、次の値の 0 個以上をビットごとの OR 演算で組み合わせて指定できます。

値 意味
IDENTITY_ASSOCIATED
0X0001
 ID が ID プロバイダーに関連付けられました。
IDENTITY_DISASSOCIATED
0X0002
 ID が ID プロバイダーから関連付け解除されました。
IDENTITY_CREATED
0X0004
 新しい ID が作成されました。
IDENTITY_IMPORTED
0X0008
 別の ID プロバイダーから ID がインポートされました。
IDENTITY_DELETED
0X0010
 ID ストアから ID が削除されました。
IDENTITY_PROPCHANGE
0X0020
 ID のプロパティの値が変更されました。
pdwCookieDWORD*outこの接続を識別する値へのポインターです。この接続の使用を終了したら、この値を UnAdvise メソッドに渡して接続を削除してください。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

vtbl 10 HRESULT UnAdvise(DWORD dwCookie)

Advise メソッドの呼び出しによって作成された接続を削除します。

dwCookieDWORDin削除する接続を識別する値です。

戻り値

メソッドが成功した場合は S_OK を返します。

メソッドが失敗した場合はエラー コードを返します。一般的なエラー コードの一覧については、Common HRESULT Values を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IIdentityProvider "{0D1B9E0C-E8BA-4F55-A81B-BCE934B948F5}"
#usecom global IIdentityProvider IID_IIdentityProvider "{}"
#comfunc global IIdentityProvider_GetIdentityEnum           3 int,var,var,sptr
#comfunc global IIdentityProvider_Create                    4 wstr,sptr,var
#comfunc global IIdentityProvider_Import                    5 sptr
#comfunc global IIdentityProvider_Delete                    6 wstr,var
#comfunc global IIdentityProvider_FindByUniqueID            7 wstr,sptr
#comfunc global IIdentityProvider_GetProviderPropertyStore  8 sptr
#comfunc global IIdentityProvider_Advise                    9 sptr,int,var
#comfunc global IIdentityProvider_UnAdvise                  10 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。