IltmmPlay::SaveSettingsToFile
#include "ltmm.h"
|
C Syntax |
HRESULT IltmmPlay_SaveSettingsToFile(pPlay, TargetFile, Flags) |
|
C++ Syntax |
HRESULT SaveSettingsToFile(TargetFile, Flags) |
|
IltmmPlay *pPlay; |
/* pointer to an interface */ |
|
BSTR TargetFile; |
/* file name */ |
|
long Flags; |
/* flags */ |
Saves some or all of the player object's settings to a file..
|
Parameter |
Description |
|
pPlay |
Pointer to an IltmmPlay interface. |
|
TargetFile |
Character string containing the name of the file in which to save the player object's settings. |
|
Flags |
Flags that indicate the saving options. For a list of possible values, refer to ltmmPlay_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 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.
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. |
See Also
|
Elements: |
IltmmPlay::SaveSettingsToStream, IltmmPlay::LoadSettingsFromFile, IltmmPlay::LoadSettingsFromStream |
|
Topics: |
Example
For a C example, refer to IltmmPlay::SaveSettingsToFile Example for C.
For a C++ example, refer to IltmmPlay::SaveSettingsToFile Example for C++.