IMbnPinManager::GetPinList 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 a list of different PIN types supported by the device.

Syntax

HRESULT GetPinList(
  [out, retval] SAFEARRAY **pinList
);

Parameters

[out, retval] pinList

A pointer to a list of MBN_PIN_TYPE values that represent the PIN types supported by the device. When GetPinList returns anything other than S_OK, pinList is NULL, otherwise the calling application must free the allocated memory by calling SafeArrayDestroy.

Return value

This method can return one of these values.

Return code Description
S_OK
 The method completed successfully.
E_PENDING
 The PIN types are not available. The Mobile Broadband service is currently probing the device to get the information. When the PIN types are available, the Mobile Broadband service will call the OnPinListAvailable method of IMbnPinManagerEvents.
E_MBN_PIN_REQUIRED
 The device requires that a PIN must be entered for this operation.
E_MBN_SIM_NOT_INSERTED
 The SIM is not inserted.
E_MBN_BAD_SIM
 A bad SIM is inserted in the device.

Remarks

On the recoverable errors E_MBN_PIN_REQUIRED, E_MBN_SIM_NOT_INSERTED, and E_MBN_BAD_SIM, the Mobile Broadband service will attempt to retrieve this information from the device when the error condition is over. While it is retrieving this information GetPinList call will return E_PENDING. Once the retrieval operation is complete, the Mobile Broadband service will call the OnPinListAvailable method of IMbnPinManagerEvents.

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

IMbnPinManager