CBaseControlWindow::get_BorderColor

 
Microsoft DirectShow 9.0

CBaseControlWindow::get_BorderColor

The get_BorderColor method retrieves the current border color.

Syntax

  HRESULT get_BorderColor(
    long *Color
);

Parameters

Color

Pointer to the current border color.

Return Value

Returns an HRESULT value.

Remarks

An application can set a destination rectangle in which the video should be displayed. This rectangle is relative to the client area for the window. If this is done (the default is to always paint the entire window), there is a border surrounding the video. This property affects the color used by the border. Although the parameter is specified as a LONG type, it is actually a COLORREF value.

This member function is meant to be called by external objects through the IVideoWindow interface, and therefore locks the critical section to synchronize with the associated filter. Call the CBaseControlWindow::GetBorderColour member function to retrieve this property if not calling from an external object.

Requirements

**  Header:** Declared in Ctlutil.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also