Skip to content

Latest commit

 

History

History
139 lines (111 loc) · 4.89 KB

nf-mbnapi-imbnradio-setsoftwareradiostate.md

File metadata and controls

139 lines (111 loc) · 4.89 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.IMbnRadio.SetSoftwareRadioState
IMbnRadio::SetSoftwareRadioState (mbnapi.h)
Sets the software radio state of a Mobile Broadband device.
IMbnRadio interface [Microsoft Broadband Networks]
SetSoftwareRadioState method
IMbnRadio.SetSoftwareRadioState
IMbnRadio::SetSoftwareRadioState
SetSoftwareRadioState
SetSoftwareRadioState method [Microsoft Broadband Networks]
SetSoftwareRadioState method [Microsoft Broadband Networks]
IMbnRadio interface
mbn.imbnradio_setsoftwareradiostate
mbnapi/IMbnRadio::SetSoftwareRadioState
mbn\imbnradio_setsoftwareradiostate.htm
mbn
d140109d-5659-42aa-b645-996dfc5a9d4e
12/05/2018
IMbnRadio interface [Microsoft Broadband Networks],SetSoftwareRadioState method, IMbnRadio.SetSoftwareRadioState, IMbnRadio::SetSoftwareRadioState, SetSoftwareRadioState, SetSoftwareRadioState method [Microsoft Broadband Networks], SetSoftwareRadioState method [Microsoft Broadband Networks],IMbnRadio interface, mbn.imbnradio_setsoftwareradiostate, mbnapi/IMbnRadio::SetSoftwareRadioState
mbnapi.h
Windows
Windows 7 [desktop apps only]
None supported
Mbnapi.idl
Windows
19H1
IMbnRadio::SetSoftwareRadioState
mbnapi/IMbnRadio::SetSoftwareRadioState
c++
APIRef
kbSyntax
COM
mbnapi.h
IMbnRadio.SetSoftwareRadioState

IMbnRadio::SetSoftwareRadioState

-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.

Sets the software radio state of a Mobile Broadband device.

-parameters

-param radioState [in]

A MBN_RADIO value that specifies the new software radio state.

-param requestID [out]

A pointer to a request ID assigned by the Mobile Broadband service to identify this request.

-returns

This method can return one of these values.

Return code Description
S_OK
The operation was successful.
E_HANDLE
The interface is invalid. Most likely,the Mobile Broadband device has been removed from the system.
HRESULT_FROM_WIN32(ERROR_NOT_FOUND)
The interface is invalid. Most likely the Mobile Broadband device has been removed from the system.
HRESULT_FROM_WIN32(ERROR_SERVICE_NOT_ACTIVE)
The Mobile Broadband service is not running on this system.

-remarks

SetSoftwareRadioState changes the software radio state of the device. This is an asynchronous operation and it will return immediately. On completion, the Mobile Broadband service will call the OnSetSoftwareRadioStateComplete method of the IMbnRadioEvents interface.

Disabling the radio for a Mobile Broadband device will result in deactivation of any active connection, network packet detach, and network deregistration. If the radio off operation results in a change in the connection state, packet attach state, or network registration state, then the application will receive a notification of the changes.

When both software and hardware radio are enabled for a Mobile Broadband device, it will automatically try to register to the network. Also, some devices may also try to a perform packet attach to the network. Whenever the state changes, the calling application will receive event notifications for network registration and packet attach state changes.

A device's radio state can change without a change request from the application. For instance, if a user turns on the system's hardware radio switch. The Mobile Broadband service will notify the application about a change in radio state by calling the OnRadioStateChange method of the IMbnRadioEvents interface.

-see-also

IMbnRadio