Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IMbnInterface::GetVisibleProviders method

Gets the list of visible providers.

Syntax


HRESULT GetVisibleProviders(
  [out, retval] ULONG                   *age,
  [out, retval] SAFEARRAY(MBN_PROVIDER) *visibleProviders
);

Parameters

age [out, retval]

A pointer to the time in seconds since the last refresh of the visible provider list from the device.

visibleProviders [out, retval]

Pointer to an array of MBN_PROVIDER structures that contains the list of providers for the interface. If this method returns any value other than S_OK, this parameter is NULL. Otherwise, upon completion, the calling program must free the allocated memory by calling SafeArrayDestroy.

Return value

This method can return one of these values.

Return codeDescription
S_OK

The method completed successfully. visibleProviders contains valid values. Based on the age of the information, the calling application can decide to issue a new call to ScanNetwork.

E_PENDING

The information is not available. An active network scan is in progress. The calling application can get notified when the device capabilities are available by registering for the OnScanNetworkComplete method of IMbnInterfaceEvents.

E_MBN_INVALID_CACHE

Mobile Broadband's cache of the visible network list is invalid. The calling application should call ScanNetwork to populate the cache.

 

Remarks

This method returns the list of currently visible providers. CDMA devices will report only their home provider if any network in their preferred roaming list (PRL) is available.

To avoid frequent network scan operations, the operating system maintains a list of recent scan operations and the provider list is returned from the cached list.

An application can call this method to get a list of visible providers upon the completion of ScanNetwork.

Requirements

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

None supported [desktop apps | Windows Store apps]

IDL

Mbnapi.idl

See also

IMbnInterface

 

 

Community Additions

Show:
© 2015 Microsoft