IltmmPlay::SaveStillDIB

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay_SaveStillDIB(pPlay, filename, timeout)

C++ Syntax

HRESULT SaveStillDIB(filename, timeout)

 

IltmmPlay *pPlay;

/* pointer to an interface */

BSTR filename;

/* string */

long timeout;

/* time */

Saves a snapshot as a DIB, from the running stream to a file.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

filename

A character string containing the name of the file in which to save the DIB.

time

The timeout period in milliseconds. The method will fail if it was not able to take a DIB in the specified time. Use –1 to wait indefinitely until a DIB is snapped.

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

This method blocks (does not return) until the timeout occurs or the DIB is snapped.

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, IltmmPlay::GetStillPicture

Topics:

Multimedia Function Group

Example

For a C example, refer to the IltmmPlay::SaveStillDIB Example for C.

For a C++ example, refer to the IltmmPlay::SaveStillDIB Example for C++.