ActiveBasicDevice::GetEffectiveBandwidth method

Gets the current effective bandwidth for the device.

Syntax

HRESULT GetEffectiveBandwidth(
  [in, retval] boolean transmitSpeed,
  [out]        ULONG64 *currentSpeed
);

Parameters

transmitSpeed [in, retval]

Specifies whether the transmit speed is retrieved or the receive speed is retrieved.

true to retrieve the transmit speed. false to retrieve the receive speed.

currentSpeed [out]

Receives the current effective bandwidth.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client
Windows 8.1 [desktop apps only]
Minimum supported server
Windows Server 2012 R2 [desktop apps only]
Header
PlayToDevice.h
IDL
PlayToDevice.idl
DLL
Playtodevice.dll

See also

ActiveBasicDevice