In This Topic ▼

IltmmCapture::SaveSettingsToFile

Summary

Saves some or all of the capture object's settings to a file. IltmmCapture::SaveSettingsToFile provides a convenient mechanism to save settings that can be retrieved at a later time.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmCapture_SaveSettingsToFile(pCapture, targetfile, flags)
C++	HRESULT SaveSettingsToFile(targetfile, flags)

Parameters

IltmmCapture *pCapture

Pointer to an IltmmCapture interface.

BSTR targetfile

Character string containing the name of the file in which to save the capture object's settings.

long flags

Flags that indicate the saving options. For a list of possible values, refer to ltmmCapture_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 capture object's settings can be saved to a stream by calling IltmmCapture::SaveSettingsToStream.

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

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