IRadioInstance::SetRadioState method
TheSetRadioState method sets the device radio state for the radio instance.
Syntax
HRESULT SetRadioState(
[in] DEVICE_RADIO_STATE RadioState,
[in] UINT32 uTimeoutSec
);
Parameters
RadioState [in]
Indicates the radio state to set. Possible values include:Value Meaning DRS_RADIO_ON 0x0 The device radio is "On". In this state the device is working, open to software control, and ready to make connection.
DRS_SW_RADIO_OFF 0x1 The device radio is "Off". Transition to this state is the result of a programmatic call.
uTimeoutSec [in]
Specifies the time-out value in seconds. The recommended value range is between 1 and 5 seconds.
Return value
Returns S_OK on success or one of the standard error HRESULT values.
Remarks
This is a synchronous call; returning S_OK if the radio is successfully set.
Requirements
Minimum supported client |
Windows 8 |
Minimum supported server |
Windows Server 2012 |
Target platform |
Desktop |
See also