Platform SDK: TAPI

ITConnection::SetBandwidthInfo

Sets the bandwidth information.

HRESULT SetBandwidthInfo(
  BSTR pModifier,
  DOUBLE Bandwidth
);

Parameters

pModifier
[in] Pointer to a BSTR indicating the scope of the bandwidth being set. For more information, see the following Remarks section.
Bandwidth
[in] Bandwidth.

Return Values

Value Meaning
S_OK Method succeeded.
E_INVALIDARG The pModifier or Bandwidth parameter is not valid.
E_OUTOFMEMORY Insufficient memory exists to perform the operation.
E_FAIL Unspecified error.
E_NOTIMPL This method is not yet implemented.

Remarks

The application must use SysAllocString to allocate memory for the pModifier parameter and use SysFreeString to free the memory when the variable is no longer needed.

Reference: RFC 2327.

The bandwidth modifier will normally be either CT or AS:

CT Conference Total: An implicit maximum bandwidth is associated with each TTL on the Mbone or within a particular multicast administrative scope region (the Mbone bandwidth versus TTL limits are given in the MBone FAQ). If the bandwidth of a session or media in a session is different from the bandwidth implicit from the scope, a `b=CT:...' line should be supplied for the session giving the proposed upper limit to the bandwidth used. The primary purpose of this is to give an approximate idea as to whether two or more conferences can coexist simultaneously.

AS Application-Specific Maximum: The bandwidth is interpreted to be application-specific, i.e., will be the application's concept of maximum bandwidth. Normally this will coincide with what is set on the application's "maximum bandwidth" control, if applicable.

Note that CT gives a total bandwidth figure for all the media at all sites. AS gives a bandwidth figure for a single media at a single site, although there may be many sites sending simultaneously.

Extension Mechanism: Tool writers can define experimental bandwidth modifiers by prefixing their modifiers with "X-".

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Sdpblb.h.
  Library: Use Sdpblbid.lib.

See Also

ITConnection