Skip to content

Latest commit

 

History

History
141 lines (118 loc) · 4.67 KB

nf-mbnapi-imbnsms-getsmsstatus.md

File metadata and controls

141 lines (118 loc) · 4.67 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mbnapi.IMbnSms.GetSmsStatus
IMbnSms::GetSmsStatus (mbnapi.h)
Gets the SMS status for a device.
GetSmsStatus
GetSmsStatus method [Microsoft Broadband Networks]
GetSmsStatus method [Microsoft Broadband Networks]
IMbnSms interface
IMbnSms interface [Microsoft Broadband Networks]
GetSmsStatus method
IMbnSms.GetSmsStatus
IMbnSms::GetSmsStatus
mbn.imbnsms_getsmsstatus
mbnapi/IMbnSms::GetSmsStatus
mbn\imbnsms_getsmsstatus.htm
mbn
58cb60dd-160c-4e1c-a244-7f20b5e79b64
12/05/2018
GetSmsStatus, GetSmsStatus method [Microsoft Broadband Networks], GetSmsStatus method [Microsoft Broadband Networks],IMbnSms interface, IMbnSms interface [Microsoft Broadband Networks],GetSmsStatus method, IMbnSms.GetSmsStatus, IMbnSms::GetSmsStatus, mbn.imbnsms_getsmsstatus, mbnapi/IMbnSms::GetSmsStatus
mbnapi.h
Windows
Windows 7 [desktop apps only]
None supported
Mbnapi.idl
Windows
19H1
IMbnSms::GetSmsStatus
mbnapi/IMbnSms::GetSmsStatus
c++
APIRef
kbSyntax
COM
mbnapi.h
IMbnSms.GetSmsStatus

IMbnSms::GetSmsStatus

-description

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 SMS status for a device.

-parameters

-param smsStatusInfo [out]

A pointer to a MBN_SMS_STATUS_INFO structure, containing the status information for the device.

-returns

This method can return one of these values.

Return code Description
S_OK
The method completed successfully.
E_PENDING
The SMS status is not available. The Mobile Broadband service is probing the device for the information. The calling application can be notified when the SMS status is available by registering for the OnSmsStatusChange method of the IMbnSmsEvents interface.
E_MBN_PIN_REQUIRED
A PIN is required to get this information.
E_MBN_SIM_NOT_INSERTED
A SIM is not inserted in the device.
E_MBN_BAD_SIM
A bad SIM is inserted in the device.

-remarks

For recoverable errors such as E_MBN_PIN_REQUIRED, E_MBN_SIM_NOT_INSERTED, and E_MBN_BAD_SIM, the Mobile Broadband service will query the device again for this information when error condition is over. For example, if the device required a PIN to be entered to retrieve this information then it will return E_MBN_PIN_REQUIRED. When an application enters the PIN to unlock the device then the Mobile Broadband service will again try to get this information from the device. The Mobile Broadband service will call the OnSmsStatusChange method of the IMbnSmsEvents interface

The SMS Message store status can change because of new message received by the system. On any change in the message store status, the Mobile Broadband service will call the OnSmsStatusChange method of the IMbnSmsEvent interface.

Application issued operations such as the reading or deleting of messages may reset flag in MBN_SMS_STATUS_INFO structure. A change in the SMS store caused by this reset will not result in the calling of any notification method.

-see-also

IMbnSms