Edit

IMbnInterface::GetSubscriberInformation method (mbnapi.h)

  • Article

Important

Starting in Windows 10, version 1803, the Win32 APIs described in this section are replaced by the Windows Runtime APIs in the Windows.Networking.Connectivity namespace.

Gets the subscriber information.

Syntax

HRESULT GetSubscriberInformation(
  [out, retval] IMbnSubscriberInformation **subscriberInformation
);

Parameters

[out, retval] subscriberInformation

A pointer to the address of an IMbnSubscriberInformation interface that contains subscriber information for the device. If this method returns any value other than S_OK, this parameter is NULL.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method completed successfully. subscriberInformation contains a valid interface.
E_PENDING
 The information is not available. The Mobile Broadband service is currently probing for the information. The calling application can get notified when the information is available by registering for the OnSubscriberInformationChange method of IMbnInterfaceEvents.

Remarks

The GetSubscriberInformation method returns the subscriber-related information, including subscriber ID, SIM international circuit card number, and phone numbers associated with this interface.

When this method is called from a Windows Store app with mobile operator privileges it will only return the SIM International circuit card number defined by the SimIccID property.

Some of the values returned in subscriber information are populated only when the ready state which as reported by the GetReadyState method of IMbnInterface is MBN_READY_STATE_INITIALIZED. Whenever there is a change in the subscriber information associated with the Mobile Broadband device, the Mobile Broadband service will notify registered applications by calling the OnSubscriberInformationChange method of IMbnInterfaceEvents.

Subscriber information for a device will not change once the device ready state is MBN_READY_STATE_INITIALIZED.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server None supported
Target Platform Windows
Header mbnapi.h

See also

IMbnInterface