IVideoWindow::put_BorderColor method

The put_BorderColor method sets the color that appears around the edges of the destination rectangle.

Syntax


HRESULT put_BorderColor(
  [inlong Color
);

Parameters

Color [in]

The border color, specified as a COLORREF value.

Return value

Possible return values include the following:

Return codeDescription
S_OK

Success.

VFW_E_NOT_CONNECTED

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Control.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IVideoWindow Interface
IVideoWindow::get_BorderColor
IBasicVideo::SetDestinationPosition

 

 

Show: