In This Topic ▼

IltmmPlay::SaveSettingsToStream

Summary

Saves some or all of the player object's settings to a stream..

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmPlay_SaveSettingsToStream(pPlay, targetstream, flags)
C++	HRESULT SaveSettingsToStream(targetstream, flags)

Parameters

IltmmPlay *pPlay

Pointer to an IltmmPlay interface.

IUnknown *targetstream

Pointer to the stream object, an object that implements IStream, that will receive the player object's settings.

long flags

Flags that indicate the saving options. For a list of possible values, refer to ltmmPlay_Settings Constants.

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 player object's settings can be saved to a file by calling IltmmPlay::SaveSettingsToFile.

Saved settings can be loaded using IltmmPlay::LoadSettingsFromFile or IltmmPlay::LoadSettingsFromStream.

It may be helpful to call IltmmPlay::CanSaveObjectSettings before calling either IltmmPlay::SaveSettingsToFile or IltmmPlay::SaveSettingsToStream, to make sure the settings you want to save can be saved. If either IltmmPlay::SaveSettingsToFile or IltmmPlay::SaveSettingsToStream is called for settings that cannot be saved, the save function will fail.