IltmmCapture::SaveSettingsToFile

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_SaveSettingsToFile(pCapture, TargetFile, Flags)

C++ Syntax

HRESULT SaveSettingsToFile(TargetFile, Flags)

 

IltmmCapture *pCapture;

/* pointer to an interface */

BSTR TargetFile;

/* file name */

long Flags;

/* flags */

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

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

TargetFile

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

Flags

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

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

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.

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

See Also

Elements:

IltmmCapture::SaveSettingsToStream, IltmmCapture::LoadSettingsFromFile, IltmmCapture::LoadSettingsFromStream

Topics:

Multimedia Function Group

Example

For a C example, refer to IltmmCapture::SaveSettingsToFile Example for C.

For a C++ example, refer to IltmmCapture::SaveSettingsToFile Example for C++.