Win32 API 日本語リファレンス
ホームNetworkManagement.MobileBroadband › IMbnPinEvents

IMbnPinEvents

COM
IIDdcbbbab6-2008-4bbb-aaee-338e368af6fa継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

このインターフェイスは、非同期の PIN リクエストが完了したことを通知するために使用される通知インターフェイスです。

解説(Remarks)

通知を登録する手順は次のとおりです。

  1. IMbnInterfaceManager オブジェクトに対して QueryInterface を呼び出し、IConnectionPointContainer インターフェイスを取得します。
  2. 返されたインターフェイスに対して FindConnectionPoint を呼び出し、riidIID_IMbnPinEvents を渡します。
  3. 返された接続ポイントに対して Advise を呼び出し、IMbnPinEvents を実装するオブジェクト上の IUnknown インターフェイスへのポインターを pUnk に渡します。
手順 2 で返された接続ポイントに対して Unadvise を呼び出すことで、通知を終了できます。

COM 通知を登録するコードの例については、COM Connection Points の記事の Client セクションを参照してください。

メソッド 5

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

vtbl 3 HRESULT OnEnableComplete(IMbnPin* pin, MBN_PIN_INFO* pinInfo, DWORD requestID, HRESULT status)

PIN の有効化操作が完了したことを示すために、モバイルブロードバンドサービスによって呼び出される通知メソッドです。

pinIMbnPin*inPIN の種類を表す IMbnPin インターフェイスです。
pinInfoMBN_PIN_INFO*in操作が失敗した場合の残り試行回数に関する情報を格納する MBN_PIN_INFO 構造体へのポインターです。pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。
requestIDDWORDinPIN 有効化リクエストを識別するためにモバイルブロードバンドサービスによって設定されるリクエスト ID です。
statusHRESULTin

操作の結果を示すステータスコードです。

呼び出し元のアプリケーションは、次のいずれかの値を想定できます。

意味
S_OK
操作は成功しました。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
デバイスはこの操作をサポートしていません。
E_FAIL
操作を完了できませんでした。
E_MBN_PIN_REQUIRED
操作を完了するには PIN が必要です。呼び出し元のアプリケーションは、IMbnPinManagerGetPinState メソッドを呼び出して、必要とされる PIN の種類を確認できます。
E_MBN_SIM_NOT_INSERTED
デバイスに SIM がありません。
E_MBN_BAD_SIM
デバイスに不正な SIM があります。
E_MBN_FAILURE
PIN の使用に失敗した試行があります。

戻り値

このメソッドは S_OK を返す必要があります。

解説(Remarks)

OnEnableComplete メソッドは、IMbnPinEnable メソッドの呼び出しによって開始された PIN 有効化操作の完了ステータスを報告するために、モバイルブロードバンドサービスによって呼び出されます。

pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。pinState メンバーは無視する必要があり、pinType フィールドには現在の IMbnPin インターフェイスの PIN の種類が設定されます。この構造体には、有効な PIN を入力するための残り試行回数が格納されます。

たとえば、PIN の種類を変更するために渡された PIN が正しくない場合、操作はステータスコード E_MBN_FAILURE で失敗します。この場合、pinInfo.attemptsRemaining は、この操作を再試行できる残り回数を示します。 誤った PIN での試行を繰り返して attemptsRemaining が 0 になった場合、アプリケーションは IMbnPinManagerGetPinState メソッドを呼び出して、必要な PIN の種類を取得できます。

vtbl 4 HRESULT OnDisableComplete(IMbnPin* pin, MBN_PIN_INFO* pinInfo, DWORD requestID, HRESULT status)

PIN の無効化操作が完了したことを示すために、モバイルブロードバンドサービスによって呼び出される通知メソッドです。

pinIMbnPin*inPIN の種類を表す IMbnPin インターフェイスです。
pinInfoMBN_PIN_INFO*in操作が失敗した場合の残り試行回数に関する情報を格納する MBN_PIN_INFO 構造体へのポインターです。pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。
requestIDDWORDinPIN 無効化リクエストを識別するためにモバイルブロードバンドサービスによって設定されるリクエスト ID です。
statusHRESULTin

操作の結果を示すステータスコードです。

呼び出し元のアプリケーションは、次のいずれかの値を想定できます。

意味
S_OK
操作は成功しました。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
デバイスはこの操作をサポートしていません。
E_FAIL
操作を完了できませんでした。
E_MBN_PIN_REQUIRED
操作を完了するには PIN が必要です。呼び出し元のアプリケーションは、IMbnPinManagerGetPinState メソッドを呼び出して、必要とされる PIN の種類を確認できます。
E_MBN_SIM_NOT_INSERTED
デバイスに SIM がありません。
E_MBN_BAD_SIM
デバイスに不正な SIM があります。
E_MBN_FAILURE
PIN の使用に失敗した試行があります。

戻り値

このメソッドは S_OK を返す必要があります。

解説(Remarks)

OnDisableComplete メソッドは、IMbnPinDisable メソッドの呼び出しによって開始された PIN 無効化操作の完了ステータスを報告するために、モバイルブロードバンドサービスによって呼び出されます。

pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。pinState メンバーは無視する必要があり、pinType フィールドには現在の IMbnPin インターフェイスの PIN の種類が設定されます。この構造体には、有効な PIN を入力するための残り試行回数が格納されます。

たとえば、PIN の種類を変更するために渡された PIN が正しくない場合、操作はステータスコード E_MBN_FAILURE で失敗します。この場合、pinInfo.attemptsRemaining は、この操作を再試行できる残り回数を示します。 誤った PIN での試行を繰り返して attemptsRemaining が 0 になった場合、アプリケーションは IMbnPinManagerGetPinState メソッドを呼び出して、必要な PIN の種類を取得できます。

vtbl 5 HRESULT OnEnterComplete(IMbnPin* Pin, MBN_PIN_INFO* pinInfo, DWORD requestID, HRESULT status)

PIN の入力操作が完了したことを示すために、モバイルブロードバンドサービスによって呼び出される通知メソッドです。

PinIMbnPin*inPIN の種類を表す IMbnPin インターフェイスです。
pinInfoMBN_PIN_INFO*in操作が失敗した場合の残り試行回数に関する情報を格納する MBN_PIN_INFO 構造体へのポインターです。pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。
requestIDDWORDinPIN 入力リクエストを識別するためにモバイルブロードバンドサービスによって設定されるリクエスト ID です。
statusHRESULTin

操作の結果を示すステータスコードです。

呼び出し元のアプリケーションは、次のいずれかの値を想定できます。

意味
S_OK
操作は成功しました。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
デバイスはこの操作をサポートしていません。
E_FAIL
操作を完了できませんでした。
E_MBN_PIN_REQUIRED
操作を完了するには PIN が必要です。呼び出し元のアプリケーションは、IMbnPinManagerGetPinState メソッドを呼び出して、必要とされる PIN の種類を確認できます。
E_MBN_SIM_NOT_INSERTED
デバイスに SIM がありません。
E_MBN_BAD_SIM
デバイスに不正な SIM があります。

戻り値

このメソッドは S_OK を返す必要があります。

解説(Remarks)

OnEnterComplete メソッドは、IMbnPinEnter メソッドの呼び出しによって開始された PIN 入力操作の完了ステータスを報告するために、モバイルブロードバンドサービスによって呼び出されます。

pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。pinState メンバーは無視する必要があり、pinType フィールドには現在の IMbnPin インターフェイスの PIN の種類が設定されます。この構造体には、有効な PIN を入力するための残り試行回数が格納されます。

たとえば、PIN の種類を変更するために渡された PIN が正しくない場合、操作はステータスコード E_MBN_FAILURE で失敗します。この場合、pinInfo.attemptsRemaining は、この操作を再試行できる残り回数を示します。 誤った PIN での試行を繰り返して attemptsRemaining が 0 になった場合、アプリケーションは IMbnPinManagerGetPinState メソッドを呼び出して、必要な PIN の種類を取得できます。

vtbl 6 HRESULT OnChangeComplete(IMbnPin* Pin, MBN_PIN_INFO* pinInfo, DWORD requestID, HRESULT status)

PIN の変更操作が完了したことを示すために、モバイルブロードバンドサービスによって呼び出される通知メソッドです。

PinIMbnPin*inPIN の種類を表す IMbnPin インターフェイスです。
pinInfoMBN_PIN_INFO*in操作が失敗した場合の残り試行回数に関する情報を格納する MBN_PIN_INFO 構造体へのポインターです。pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。
requestIDDWORDinPIN 変更リクエストを識別するためにモバイルブロードバンドサービスによって設定されるリクエスト ID です。
statusHRESULTin

PIN 変更操作の結果を示すステータスコードです。

呼び出し元のアプリケーションは、次のいずれかの値を想定できます。

意味
S_OK
操作は成功しました。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
デバイスはこの操作をサポートしていません。
E_FAIL
操作を完了できませんでした。
E_MBN_PIN_REQUIRED
操作を完了するには PIN が必要です。呼び出し元のアプリケーションは、IMbnPinManagerGetPinState メソッドを呼び出して、必要とされる PIN の種類を確認できます。
E_MBN_SIM_NOT_INSERTED
デバイスに SIM がありません。
E_MBN_BAD_SIM
デバイスに不正な SIM があります。
E_MBN_PIN_DISABLED
無効化された PIN に対しては PIN 変更操作はサポートされていません。

戻り値

このメソッドは S_OK を返す必要があります。

解説(Remarks)

OnChangeComplete メソッドは、IMbnPinChange メソッドの呼び出しによって開始された PIN 変更操作の完了ステータスを報告するために、モバイルブロードバンドサービスによって呼び出されます。

pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。pinState メンバーは無視する必要があり、pinType フィールドには現在の IMbnPin インターフェイスの PIN の種類が設定されます。この構造体には、有効な PIN を入力するための残り試行回数が格納されます。

たとえば、PIN の種類を変更するために渡された PIN が正しくない場合、操作はステータスコード E_MBN_FAILURE で失敗します。この場合、pinInfo.attemptsRemaining は、この操作を再試行できる残り回数を示します。 誤った PIN での試行を繰り返して attemptsRemaining が 0 になった場合、アプリケーションは IMbnPinManagerGetPinState メソッドを呼び出して、必要な PIN の種類を取得できます。

vtbl 7 HRESULT OnUnblockComplete(IMbnPin* Pin, MBN_PIN_INFO* pinInfo, DWORD requestID, HRESULT status)

PIN のブロック解除操作が完了したことを示すために、モバイルブロードバンドサービスによって呼び出される通知メソッドです。

PinIMbnPin*inPIN の種類を表す IMbnPin インターフェイスです。
pinInfoMBN_PIN_INFO*in操作が失敗した場合の残り試行回数に関する情報を格納する MBN_PIN_INFO 構造体へのポインターです。pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。
requestIDDWORDinPIN ブロック解除リクエストを識別するためにモバイルブロードバンドサービスによって設定されるリクエスト ID です。
statusHRESULTin

操作の結果を示すステータスコードです。

呼び出し元のアプリケーションは、次のいずれかの値を想定できます。

意味
S_OK
操作は成功しました。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
デバイスはこの操作をサポートしていません。
E_FAIL
操作を完了できませんでした。
E_MBN_PIN_REQUIRED
操作を完了するには PIN が必要です。呼び出し元のアプリケーションは、IMbnPinManagerGetPinState メソッドを呼び出して、必要とされる PIN の種類を確認できます。
E_MBN_SIM_NOT_INSERTED
デバイスに SIM がありません。
E_MBN_BAD_SIM
デバイスに不正な SIM があります。

戻り値

このメソッドは S_OK を返す必要があります。

解説(Remarks)

OnUnblockComplete メソッドは、IMbnPinUnblock メソッドの呼び出しによって開始された PIN ブロック解除操作の完了ステータスを報告するために、モバイルブロードバンドサービスによって呼び出されます。

pinInfo の内容は、statusE_MBN_FAILURE の場合にのみ意味を持ちます。pinState メンバーは無視する必要があり、pinType フィールドには現在の IMbnPin インターフェイスの PIN の種類が設定されます。この構造体には、有効な PIN を入力するための残り試行回数が格納されます。

たとえば、PIN の種類を変更するために渡された PIN が正しくない場合、操作はステータスコード E_MBN_FAILURE で失敗します。この場合、pinInfo.attemptsRemaining は、この操作を再試行できる残り回数を示します。 誤った PIN での試行を繰り返して attemptsRemaining が 0 になった場合、アプリケーションは IMbnPinManagerGetPinState メソッドを呼び出して、必要な PIN の種類を取得できます。

デバイスのブロック解除に失敗し、その PUK ブロックが MBN_PIN_TYPE_PIN1 の PIN によるものである場合、デバイスの準備状態も MBN_READY_STATE_BAD_SIM に変化する結果となります。呼び出し元のアプリケーションには、IMbnInterfaceEventsOnReadyStateChange メンバーを通じて ReadyState の変化が通知されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMbnPinEvents "{DCBBBAB6-2008-4BBB-AAEE-338E368AF6FA}"
#usecom global IMbnPinEvents IID_IMbnPinEvents "{}"
#comfunc global IMbnPinEvents_OnEnableComplete   3 sptr,var,int,int
#comfunc global IMbnPinEvents_OnDisableComplete  4 sptr,var,int,int
#comfunc global IMbnPinEvents_OnEnterComplete    5 sptr,var,int,int
#comfunc global IMbnPinEvents_OnChangeComplete   6 sptr,var,int,int
#comfunc global IMbnPinEvents_OnUnblockComplete  7 sptr,var,int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。