In This Topic ▼

IltmmMediaSampleDisp::get_Buffer

Summary

Gets a reference for direct access to the sample buffer.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmMediaSampleDisp_get_Buffer(pMediaSampleDisp, pVal)
C++	HRESULT get_Buffer(pVal)

Parameters

IltmmMediaSampleDisp *pMediaSampleDisp

Pointer to an IltmmMediaSampleDisp interface.

VARIANT *pVal

Pointer to a variable to be updated with a SAFEARRAY reference encapsulated within a VARIANT. The array is composed of a single dimension of bytes. This array contains the sample buffer data.

Returns

Value	Meaning
S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

The returned array allows direct read/write access to the sample buffer for in-process clients only (which is the typical case). Out-of-process clients should treat the returned array as read-only and should call the IltmmMediaSampleDisp::SetData function to write to the buffer.

If the function succeeds, the caller must free the returned VARIANT by calling the VariantClear function. VariantClear would free the memory allocated for the VARIANT, not the buffer itself.