CBaseControlVideo::GetDestinationPosition

Microsoft DirectShow 9.0

CBaseControlVideo::GetDestinationPosition

The GetDestinationPosition method retrieves the destination rectangle in one atomic operation.

Syntax

  HRESULT GetDestinationPosition(
    long *pLeft,
    long *pTop,
    long *pWidth,
    long *pHeight
);

Parameters

pLeft

Pointer to the left coordinate of the destination rectangle.

pTop

Pointer to the top coordinate of the destination rectangle.

pWidth

Pointer to the width of the destination rectangle.

pHeight

Pointer to the height of the destination rectangle.

Return Value

Returns an HRESULT value that depends on the implementation; can be one of the following values, or other values not listed.

Value	Description
E_FAIL	Failure.
E_POINTER	Null pointer argument.
VFW_E_NOT_CONNECTED	The operation cannot be performed because the pins are not connected.
NOERROR	Success.

Remarks

This member function can be used in place of separate calls to the CBaseControlVideo::get_DestinationLeft, CBaseControlVideo::get_DestinationTop, CBaseControlVideo::get_DestinationWidth, and CBaseControlVideo::get_DestinationHeight member functions. An application can change the source and destination rectangles for the video through the IBasicVideo interface. The source rectangle affects which section of the native video source will appear on the display; the destination rectangle affects where the video will appear when played. The destination rectangle is relative to the client area of the window in which it is playing. The upper-left corner of the window is coordinate (0,0).

Requirements

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

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

See Also

• CBaseControlVideo Class