IltmmMemory::GetData

#include "ltmm.h"

C Syntax	HRESULT IltmmMemory__getData(pMem, Index, Count, pVal)
C++ Syntax	HRESULT GetData(Index, Count, pVal)

IltmmMemory *pMem;	/* pointer to an interface */
long Index;	/* index */
long Count;	/* size */
VARIANT *pVal;	/* pointer to a VARIANT */

Retrieves a block of data from the object’s buffer.

Parameter	Description
pMem	Pointer to an IltmmMemory interface.
Index	Index, or offset, from which to retrieve the data from the object’s buffer.
Count	Size of the data to retrieve (number of elements, in bytes).
pVal	Pointer to a variable to be updated with a VARIANT containing a SAFEARRAY reference to the block of data.

Returns

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

If the size of the data to retrieve is larger than the size available after the offset, the function will retrieve only the available data between the offset and the end of the buffer.

This function allocates the required memory for the SAFEARRAY; the caller is responsible for freeing it.

The area of the object's buffer from which the data is retrieved will be locked for the duration of the call.

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Elements:	IltmmMemory::get_BufferSize, IltmmMemory::CopyData, IltmmMemory::GetData, IltmmMemory::put_BufferSize, IltmmMemory::GetByte, IltmmMemory::SetData
Topics:	Multimedia Function Group