IDirectDrawMediaSample::GetSurfaceAndReleaseLock method (amstream.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 GetSurfaceAndReleaseLock method retrieves and unlocks the surface that the sample represents.

Syntax

HRESULT GetSurfaceAndReleaseLock(
  [out] IDirectDrawSurface **ppDirectDrawSurface,
  [out] RECT               *pRect
);

Parameters

[out] ppDirectDrawSurface

Address of a pointer to the sample's IDirectDrawSurface interface.

[out] pRect

Pointer to a variable that receives the address of the rectangle defining the part of the surface that the sample represents.

Return value

Returns an HRESULT value.

Remarks

The caller should release the returned surface pointer, except when calling the Overlay Mixer filter's implementation of this interface.

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 amstream.h
Library Strmiids.lib

See also

Error and Success Codes

IDirectDrawMediaSample Interface