IltmmConvert::SaveSettingsToFile

#include "ltmm.h"

C Syntax

HRESULT IltmmConvert_SaveSettingsToFile(pConvert, TargetFile, Flags)

C++ Syntax

HRESULT SaveSettingsToFile(TargetFile, Flags)

 

IltmmConvert *pConvert;

/* 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

pConvert

Pointer to an IltmmConvert interface.

TargetFile

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

Flags

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

Settings that have been saved to a file can be loaded using IltmmConvert::LoadSettingsFromFile. Settings that have been saved to a stream can be loaded using IltmmConvert::LoadSettingsFromStream.

It may be helpful to call IltmmConvert::CanSaveObjectSettings before calling either IltmmConvert::SaveSettingsToFile or IltmmConvert::SaveSettingsToStream, to make sure the settings you want to save can be saved. If either IltmmConvert::SaveSettingsToFile or IltmmConvert::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:

IltmmConvert::SaveSettingsToStream, IltmmConvert::LoadSettingsFromFile, IltmmConvert::LoadSettingsFromStream

Topics:

Multimedia Function Group

Example

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

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