Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

Retrieves the current border color.

Syntax

HRESULT get_BorderColor(
  long* 
Color
);

Parameters

Color

Current border color.

Return Value

Returns an HRESULTvalue.

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 LONGtype, it is actually a COLORREFvalue.

This member function is meant to be called by external objects through the IVideoWindowinterface, and therefore locks the critical section to synchronize with the associated filter.

Call the CBaseControlWindow::GetBorderColourmember function to retrieve this property if not calling from an external object.

Requirements

Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment