IVideoWindow::put_BorderColor method (control.h)
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The put_BorderColor method sets the color that appears around the edges of the destination rectangle.
Syntax
HRESULT put_BorderColor(
[in] long Color
);
Parameters
[in] Color
The border color, specified as a COLORREF value.
Return value
Possible return values include the following:
| Return code | Description |
|---|---|
|
Success. |
|
The video renderer filter is not connected. |
Remarks
If the destination rectangle is smaller than the client area of the video window, a border is exposed around the edges of the video. The default color is black. Use this method to override the default color. If a palette is in use, a nonsystem color is converted to its closest match.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | control.h (include Dshow.h) |
| Library | Strmiids.lib |