IMbnPinEvents::OnEnterComplete method (mbnapi.h)

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.

Notification method called by the Mobile Broadband service to indicate that a PIN enter operation has completed

Syntax

HRESULT OnEnterComplete(
  [in] IMbnPin      *Pin,
  [in] MBN_PIN_INFO *pinInfo,
  [in] ULONG        requestID,
  [in] HRESULT      status
);

Parameters

[in] Pin

An IMbnPin interface that represents the PIN type.

[in] pinInfo

A pointer to a MBN_PIN_INFO structure that contains information on remaining attempts, in case of failure operations. The contents of pinInfo are meaningful only when status is E_MBN_FAILURE.

[in] requestID

A request ID set by the Mobile Broadband service to identify the PIN enter request.

[in] status

A status code that indicates the outcome of the operation.

A calling application can expect one of the following values.

Value Meaning
S_OK
The operation was successful.
HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)
The device does not support this operation.
E_FAIL
The operation could not be completed.
E_MBN_PIN_REQUIRED
A PIN is required for the operation to complete. The calling application can call the GetPinState method of IMbnPinManager to discover the type of expected PIN.
E_MBN_SIM_NOT_INSERTED
There is no SIM in the device.
E_MBN_BAD_SIM
There is a bad SIM in the device.

Return value

This method must return S_OK.

Remarks

The OnEnterComplete method is called by the Mobile Broadband service to report the completion status of a PIN enter operation initialized by a call to the Enter method of IMbnPin.

The contents of pinInfo are meaningful only when status is E_MBN_FAILURE. The pinState member should be ignored and pinType field is set to the PIN type of the current IMbnPin interface. This structure contains the attempts remaining to enter a valid PIN.

For example, if the PIN passed to change a PIN type is incorrect then the operation will fail with a status code of E_MBN_FAILURE. In this case, pinInfo.attemptsRemaining specifies the number of attempts remaining to retry this operation. If repeated attempts with the wrong PIN causes attemptsRemaining to become 0 then the application can call the GetPinState method of IMbnPinManager to get the type of PIN required.

Requirements

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

See also

IMbnPinEvents