IltmmSampleTarget::GetSample

#include "ltmm.h"

C Syntax	HRESULT IltmmSampleTarget__getSample(IltmmSampleTarget pSampleTarget, long TimeOut, IltmmMediaSampleDisp** MediaSample*)
C++ Syntax	HRESULT GetSample(long TimeOut, IltmmMediaSampleDisp* MediaSample*)

IltmmSampleTarget * pSampleTarget;	/* pointer to an interface */
long TimeOut;	/* time allowed to wait for sample */
IltmmMediaSampleDisp ** MediaSample;	/* pointer to a pointer */

Retrieves a delivered media sample.

Parameter	Description
pSampleTarget	Pointer to an IltmmSampleTarget interface that references the sample target object for which to get the media sample.
TimeOut	Maximum time to wait for a sample, in milliseconds.
MediaSample	Pointer to a variable that is updated with an IltmmMediaSampleDisp pointer. The IltmmMediaSampleDisp interface referenced by this pointer contains information on the media sample delivered to the sample target.

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 function succeeds, the caller must free the interface referenced by the MediaSample parameter by calling the interface's Release function.

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.

See Also

Elements:	IltmmSampleTarget::GetConnectedMediaType, IltmmSampleTarget::SetAcceptedMediaType, IltmmSampleTarget::GetAcceptedMediaType, IltmmSampleTarget::GetSample
Topics:	Multimedia Function Group
	IltmmSampleTarget Interface
	ltmmSampleTarget Object
	IltmmMediaSampleDisp Interface
	ltmmMediaSample Object

Example