In This Topic ▼

IltmmPlay::SaveSettingsToFile

Summary

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

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmPlay_SaveSettingsToFile(pPlay, targetfile, flags)
C++	HRESULT SaveSettingsToFile(targetfile, flags)

Parameters

IltmmPlay *pPlay

Pointer to an IltmmPlay interface.

BSTR targetfile

Character string containing the name of the file in which to save 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 stream by calling IltmmPlay::SaveSettingsToStream.

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.