ホーム › NetworkManagement.MobileBroadband › IMbnConnectionContext

IMbnConnectionContext

COM

📘 Microsoft Learn (日本語) · English

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

公式ドキュメント

接続コンテキストを管理します。

解説(Remarks)

アプリケーションは、IMbnInterface の QueryInterface メソッドを呼び出すことで、このインターフェイスを取得できます。

メソッド 2

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

vtbl 3 HRESULT GetProvisionedContexts(SAFEARRAY** provisionedContexts)

接続コンテキストの一覧を取得します。

provisionedContexts

SAFEARRAY**

out

デバイスに格納されている接続コンテキストを表す MBN_CONTEXT 値の一覧です。エラー時、この配列は NULL になります。成功した場合、呼び出し側のアプリケーションは SafeArrayDestroy を呼び出して、割り当てられたメモリを解放する必要があります。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

リターンコード	説明
S_OK	メソッドは正常に完了しました。
E_PENDING	接続コンテキストが利用できません。Mobile Broadband サービスが、その情報を得るためにデバイスを照会中です。呼び出し側のアプリケーションは、IMbnConnectionContextEvents の OnProvisionedContextListChange メソッドに登録することで、接続コンテキストが利用可能になったときに通知を受け取ることができます。
E_MBN_PIN_REQUIRED	接続コンテキストを取得するには PIN が必要です。
E_MBN_SIM_NOT_INSERTED	デバイスに SIM が挿入されていません。
E_MBN_BAD_SIM	デバイスに不正な SIM が挿入されています。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)	デバイスは、プロビジョニング済みコンテキストの取得をサポートしていません。

解説(Remarks)

接続コンテキストは、レイヤー 2 の物理的な Mobile Broadband 接続の上に仮想回線またはフローを設定するための、特定のネットワーク構成パラメーター一式を抽象化したものです。GSM では PDP コンテキストの概念に相当し、CDMA ではネットワークプロファイルに相当します。

場合によっては、接続パラメーターが既にデバイス/SIM のメモリに存在していることがあります。このメソッドを使用すると、現在のホームプロバイダーネットワーク向けにデバイスに格納された接続コンテキストの一覧を取得できます。

データ接続を行うには、MBN_CONTEXT_TYPE_INTERNET 型のコンテキストのみを使用してください。

デバイスは、現在のホームプロバイダー向けに格納されているすべてのコンテキストを返します。一部のコンテキストは空である場合があり、それらは MBN_CONTEXT_TYPE_NONE として報告されます。

格納されたプロビジョニング済みコンテキストが、SMS または OTA を介してネットワークによって更新される場合があります。デバイスのプロビジョニング済みコンテキストに変更があるたびに、Mobile Broadband サービスは IMbnConnectionContextEvents の OnProvisionedContextListChange メソッドを呼び出します。アプリケーションはこのメソッドを使用して、更新されたプロビジョニング済みコンテキストの一覧を取得できます。

回復可能なエラー E_MBN_PIN_REQUIRED、E_MBN_SIM_NOT_INSERTED、E_MBN_BAD_SIM の場合、Mobile Broadband サービスは、エラー状態が解消されたときにこの情報を得るためにデバイスを再度照会します。たとえば、接続コンテキストを取得するためにデバイスが PIN の入力を必要とした場合、E_MBN_PIN_REQUIRED が返されます。アプリケーションがデバイスのロックを解除するために PIN を入力すると、サービスはデバイスからこの情報を取得するために再度試みます。サービスは、IMbnConnectionContextEvents の OnProvisionedContextListChange メソッドを呼び出して、新しい照会の状態をアプリケーションに通知します。

vtbl 4 HRESULT SetProvisionedContext(MBN_CONTEXT provisionedContexts, LPWSTR providerID, DWORD* requestID)

プロビジョニング済みコンテキストを追加または更新します。

provisionedContexts	MBN_CONTEXT	in	デバイスまたは SIM に格納するプロビジョニング済みコンテキストを指定する MBN_CONTEXT 構造体です。
providerID	LPWSTR	in	プロビジョニング済みコンテキストを格納する対象のネットワークプロバイダー ID を表す文字列です。このホームプロバイダー ID を持つ SIM がデバイスに挿入されている場合、デバイスはその後の照会に応じて、追加されたプロビジョニング済みコンテキストを返す必要があります。
requestID	DWORD*	out	この非同期要求を識別するために Mobile Broadband サービスが設定する要求 ID です。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

リターンコード	説明
S_OK	メソッドは正常に完了しました。
E_HANDLE	無効なインターフェイスです。おそらく Mobile Broadband デバイスがシステムから取り外されています。
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)	無効なインターフェイスです。おそらく Mobile Broadband デバイスがシステムから取り外されています。
HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE)	このシステムで Mobile Broadband サービスが実行されていません。
E_INVALID_ARG	providerID が有効ではありません。

解説(Remarks)

provisionedContexts の contextID は、コンテキストを格納するデバイスまたは SIM メモリ内のインデックスを指定します。MBN_CONTEXT_ID_APPEND に設定されている場合、デバイスはコンテキストを格納する適切なインデックスを見つけます。

これは非同期操作であり、SetProvisionedContext はすぐに戻ります。操作が完了すると、Mobile Broadband サービスは IMbnConnectionContextEvents の OnSetProvisionedContextComplete メソッドを呼び出してアプリケーションに通知します。

現在のホームプロバイダー ID に対するプロビジョニング済みコンテキスト一覧への追加は、IMbnConnectionContextEvents の OnProvisionedContextListChange メソッドが呼び出されるまで照会できません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMbnConnectionContext "{DCBBBAB6-200B-4BBB-AAEE-338E368AF6FA}"
#usecom global IMbnConnectionContext IID_IMbnConnectionContext "{}"
#comfunc global IMbnConnectionContext_GetProvisionedContexts  3 var
#comfunc global IMbnConnectionContext_SetProvisionedContext   4 int,wstr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IMbnConnectionContext "{DCBBBAB6-200B-4BBB-AAEE-338E368AF6FA}"
#usecom global IMbnConnectionContext IID_IMbnConnectionContext "{}"
#comfunc global IMbnConnectionContext_GetProvisionedContexts  3 sptr
#comfunc global IMbnConnectionContext_SetProvisionedContext   4 int,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。