Share via

IMbnInterface::GetPreferredProviders メソッド (mbnapi.h)

  • [アーティクル]

重要

バージョン 1803 Windows 10以降、このセクションで説明する Win32 API は、Windows.Networking.Connectivity 名前空間のWindows ランタイム API に置き換えられます。

優先プロバイダーの一覧を取得します。

構文

HRESULT GetPreferredProviders(
  [out, retval] SAFEARRAY **preferredProviders
);

パラメーター

[out, retval] preferredProviders

優先プロバイダーの一覧 を 含むMBN_PROVIDER構造体の配列へのポインター。 このメソッドが S_OK 以外の値を返す場合、このパラメーターは NULL です。 GetPreferredProviders がS_OKを返す場合、呼び出し元のアプリケーションは SafeArrayDestroy を呼び出して、割り当てられたメモリを解放する必要があります。

戻り値

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

リターン コード 説明
S_OK
 メソッドは正常に完了しました。 preferredProviders には有効な値が含まれています。
E_PENDING
 この情報は使用できません。 モバイル ブロードバンド サービスは現在、優先プロバイダーの一覧を探しています。 呼び出し元のアプリケーションは、IMbnInterfaceEvents の OnPreferredProvidersChange メソッドに登録することで、データが使用可能になったときに通知を受け取ることができます。
E_MBN_PIN_REQUIRED
 デバイスでは、この操作のために PIN を入力する必要があります。
E_MBN_SIM_NOT_INSERTED
 SIM は挿入されません。
E_MBN_BAD_SIM
 デバイスに不適切な SIM が挿入されます。
HRESULT_FROM_WIN32(ERROR_READ_FAULT)
 SIM またはデバイス のメモリから読み取ることができません。 たとえば、SIM には推奨プロバイダー情報がプロビジョニングされていません。
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
 デバイスはこの操作をサポートしていません。 CDMA デバイスは常にこの値を返します。

注釈

GetPreferredProviders は、インターフェイスの優先プロバイダー リストに格納されているプロバイダーの一覧を返します。

回復可能なエラー E_MBN_PIN_REQUIRED、 E_MBN_SIM_NOT_INSERTED、 およびE_MBN_BAD_SIMの場合、モバイル ブロードバンド サービスは、エラー状態が終わると、プロバイダーの一覧に対してデバイスに対して再度クエリを実行します。 たとえば、デバイスでプロバイダーリストを取得するために PIN を入力する必要がある場合、 GetPreferredProviders は E_MBN_PIN_REQUIREDを返します。 アプリケーションが PIN を入力してデバイスのロックを解除すると、モバイル ブロードバンド サービスはデバイスからこの情報を取得しようとします。

回復可能なエラーが発生した後、オペレーティング システムがデバイスに対してクエリを実行してプロバイダーの一覧を取得すると、 GetPreferredProviders は直ちに E_PENDINGを返します。 新しいクエリが完了すると、適切なコールバック メソッドを使用して呼び出し元アプリケーションに通知が送信されます。 たとえば、PIN ロック解除操作が成功すると、IMbnPinEvents の OnEnterComplete メソッドが呼び出されます。 SIM カード エラーから復旧すると、IMbnInterfaceEvents の OnReadyStateChange メソッドが呼び出されます。

Mobile Broadband サービスは、IMbnInterfaceEvents の OnPreferredProvidersChange メソッドを呼び出すことによって、新しいクエリの状態に関するアプリケーションを更新します。

場合によっては、SMS または OTA (Over-the-air update) によって、デバイスの優先プロバイダー リストをネットワーク経由で更新できます。 オペレーティング システムは、IMbnInterfaceEvents の OnPreferredProvidersChange メソッドを呼び出すことによって、優先プロバイダー リストの変更をアプリケーションに通知します。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー サポートなし
対象プラットフォーム Windows
ヘッダー mbnapi.h

こちらもご覧ください

IMbnInterface