IMbnRegistration::GetRoamingText メソッド (mbnapi.h)

  • [アーティクル]

重要

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

ローミング プロバイダーを説明するローミング テキストを取得します。

構文

HRESULT GetRoamingText(
  [out] BSTR *roamingText
);

パラメーター

[out] roamingText

デバイスがローミングしているネットワークに関する追加情報を含む文字列へのポインター。 最大長は MBN_ROAMTEXT_LEN 文字です。 文字列は、メソッドが成功のために S_OK を返す場合にのみ入力されます。 成功した場合、呼び出し元のアプリケーションは SysFreeString を呼び出して、割り当てられたメモリを解放する必要があります。

戻り値

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

リターン コード 説明
S_OK
 操作に成功しました。
E_PENDING
 ローミング テキストは使用できません。 モバイル ブロードバンド サービスは現在、デバイスの情報をプローブしています。 ローミング テキストが使用可能になると、モバイル ブロードバンド サービスは IMbnRegistrationEvents の OnRegisterModeAvailable メソッドを呼び出します。
E_MBN_PIN_REQUIRED
 ローミング テキストを取得するには、PIN が必要です。
E_MBN_SIM_NOT_INSERTED
 SIM はデバイスに挿入されません。
E_MBN_BAD_SIM
 デバイスに無効な SIM が挿入されます。

解説

GetRoamingText メソッドは、登録状態がMBN_REGISTER_STATE_PARTNERまたはMBN_REGISTER_STATE_ROAMINGである場合に、ネットワークに関する追加情報を含むテキスト文字列を取得できます。

この情報は、モバイル ブロードバンド デバイスが 1 つのネットワークから別のネットワークに移動するときに変更される可能性があります。 これには、ネットワーク登録状態で MBN_REGISTER_STATE_HOME から MBN_REGISTER_STATE_SEARCHING に変更が加わるたびにが含まれます。 これは、ネットワークがプロバイダー間で登録を移動する場合など、登録済みネットワークに変更がある場合にも発生します。 このような変更の後、モバイル ブロードバンド サービスは IMbnRegistrationEvents の OnRegisterStateChange メソッドを呼び出します。

回復可能なエラー E_MBN_PIN_REQUIREDの場合、モバイル ブロードバンド サービスは、エラー状態が過ぎたとき (PIN が入力されたときに) デバイスからこの情報のフェッチを再試行します。 次に、IMbnRegistrationEvents の OnRegisterStateChange メソッドを呼び出します。

要件

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

関連項目

IMbnRegistration