IWMProfile3::GetBandwidthSharing method (wmsdkidl.h)
[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetBandwidthSharing method retrieves a bandwidth sharing object from a profile.
Syntax
HRESULT GetBandwidthSharing(
[in] DWORD dwBSIndex,
[out] IWMBandwidthSharing **ppBS
);
Parameters
[in] dwBSIndex
DWORD containing the index number of the bandwidth sharing object you want to retrieve.
[out] ppBS
Pointer to receive the address of the IWMBandwidthSharing interface of the object requested.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
|---|---|
|
The method succeeded. |
|
ppBS is NULL.
OR dwBSIndex refers to an invalid index number. |
|
The method is unable to allocate memory for the bandwidth sharing object. |
Remarks
Bandwidth sharing objects in a profile are assigned sequential index numbers in the order in which they were added to the profile. When you create multiple bandwidth sharing objects for a profile, you should keep track of the contents of each one. Otherwise you will have to examine each one to ascertain its settings.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series SDK, or later versions of the SDK |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | wmsdkidl.h (include Wmsdk.h) |
| Library | Wmvcore.lib; WMStubDRM.lib (if you use DRM) |
See also
IWMProfile3::AddBandwidthSharing