IltmmPlay::GetStillPicture

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay__getStillPicture(pPlay, TimeOut, ppPicture);

C++ Syntax

HRESULT GetStillPicture(TimeOut, ppPicture);

 

IltmmPlay *pPlay;

/* pointer to an interface */

long TimeOut;

/* time out period */

IPictureDisp **ppPicture;

/* pointer to a pointer */

Retrieves a picture object.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

TimeOut

Value containing the maximum time, in milliseconds, to wait for the image.

ppPicture

Pointer to a variable that receives the picture object's interface pointer.

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 method succeeds, the caller must free the returned Picture by calling the interface Release method.

If TimeOut is INFINITE, the function's time-out interval never elapses.

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.

Platforms

Win32, x64, Mobile

See Also

Elements:

IltmmPlay::GetStillDIB

Topics:

Multimedia Function Group

Example

For a C example, refer to the Simple Play Application for C.

For a C++ example, refer to the Simple Play Application for C++.