IMbnRegistration::GetRegisterState method (mbnapi.h)

Gets the registration state.

Syntax

HRESULT GetRegisterState(
  [out] MBN_REGISTER_STATE *registerState
);

Parameters

[out] registerState

A pointer an MBN_REGISTER_STATE value that specifies to the current registration state of the device. The value is meaningful only if the method returned S_OK.

Return value

This method can return one of these values.

Remarks

The GetRegisterState method gets the current network registration state of the device. The device can be registered to a network, searching the network for registration, or it can be denied registration.

The registration state of device can change automatically. For example, when the device goes out of the network coverage area, it changes the registration state from MBN_REGISTER_STATE_HOME to MBN_REGISTER_STATE_SEARCHING.

An application can register for receiving registration state change updates by connecting IMbnRegistrationEvents interface. Windows will call the OnRegisterStateChange method of IMbnRegistrationEvents to notify the application about these changes.

For the recoverable error E_MBN_PIN_REQUIRED, the Mobile Broadband service will again try to fetch this information from the device when the error condition is over (when a PIN is entered). Then it will call the OnRegisterStateChange method of IMbnRegistrationEvents.

Requirements

See also

IMbnRegistration