Méthode IMbnRegistration::GetRoamingText (mbnapi.h)

Important

À compter de Windows 10, version 1803, les API Win32 décrites dans cette section sont remplacées par les API Windows Runtime dans l’espace de noms Windows.Networking.Connectivity.

Obtient le texte d’itinérance décrivant le fournisseur d’itinérance.

Syntaxe

HRESULT GetRoamingText(
  [out] BSTR *roamingText
);

Paramètres

[out] roamingText

Pointeur vers une chaîne qui contient des informations supplémentaires sur un réseau avec lequel l’appareil est itinérant. La longueur maximale est MBN_ROAMTEXT_LEN caractères. La chaîne est remplie uniquement lorsque la méthode retourne S_OK de réussite. En cas de réussite, l’application appelante doit libérer la mémoire allouée en appelant SysFreeString.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	L'opération a réussi.
E_PENDING	Le texte itinérant n’est pas disponible. Le service Haut débit mobile est en train de sonder l’appareil pour obtenir des informations. Lorsque le texte itinérant est disponible, le service haut débit mobile appelle la méthode OnRegisterModeAvailable de IMbnRegistrationEvents.
E_MBN_PIN_REQUIRED	Un code confidentiel est requis pour obtenir le texte itinérant.
E_MBN_SIM_NOT_INSERTED	Aucune carte SIM n’est insérée dans l’appareil.
E_MBN_BAD_SIM	Une carte SIM incorrecte est insérée dans l’appareil.

Notes

La méthode GetRoamingText peut obtenir une chaîne de texte contenant des informations supplémentaires sur le réseau lorsque l’état d’inscription est MBN_REGISTER_STATE_PARTNER ou MBN_REGISTER_STATE_ROAMING.

Ces informations peuvent changer lorsque l’appareil haut débit mobile passe d’un réseau à un autre. Cela inclut chaque fois qu’il y a un changement de MBN_REGISTER_STATE_HOME à MBN_REGISTER_STATE_SEARCHING dans l’état d’inscription réseau. Cela se produit également en cas de modification du réseau inscrit, par exemple lorsqu’un réseau déplace son inscription d’un fournisseur à un autre. Après ces modifications, le service Haut débit mobile appelle la méthode OnRegisterStateChange de IMbnRegistrationEvents.

Pour l’erreur récupérable E_MBN_PIN_REQUIRED, le service haut débit mobile tente à nouveau d’extraire ces informations de l’appareil lorsque la condition d’erreur est terminée (lorsqu’un code confidentiel est entré). Ensuite, il appelle la méthode OnRegisterStateChange de IMbnRegistrationEvents.

Spécifications

Client minimal pris en charge	Windows 7 [applications de bureau | Applications UWP]
Serveur minimal pris en charge	Aucun pris en charge
Plateforme cible	Windows
En-tête	mbnapi.h

Voir aussi

IMbnRegistration