IltmmCapture::CanSaveObjectSettings
#include "ltmm.h"
|
C Syntax |
HRESULT IltmmCapture_CanSaveObjectSettings(pCapture, Flags, Status) |
|
C++ Syntax |
HRESULT CanSaveObjectSettings(Flags, Status) |
|
IltmmCapture *pCapture; |
/* pointer to an interface */ |
|
long Flags; |
/* flags */ |
|
VARIANT_BOOL *Status; |
/* pointer to a variable */ |
Determines whether the specified settings can be saved.
|
Parameter |
Description |
|
|
pCapture |
Pointer to an IltmmCapture interface. |
|
|
Flags |
Flags that indicate the settings to check. For a list of possible values, refer to the ltmmCapture_Settings constants. |
|
|
Status |
Pointer to a variable to be updated with a value that indicates whether the specified settings can be saved. Possible values are: |
|
|
|
Value |
Meaning |
|
|
VARIANT_TRUE |
The specified settings can be saved. |
|
|
VARIANT_FALSE |
The specified settings can not be saved. |
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. The capture object's settings can be saved to a file by calling IltmmCapture::SaveSettingsToFile.
Settings saved to a file can be loaded using IltmmCapture::LoadSettingsFromFile. Settings saved to a stream can be loaded using 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.
Multiple settings can be combined in the Flags parameter using the OR operator. However, please note that if settings are combined in the Flags parameter, all those settings must be capable of being saved in order for the CanSaveObjectSettings function to update the Status parameter with VARIANT_TRUE. If even one of those settings cannot be saved, then CanSaveObjectSettings will update the Status parameter with VARIANT_FALSE.
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: |
IltmmCapture::SaveSettingsToFile, IltmmCapture::LoadSettingsFromFile, IltmmCapture::LoadSettingsFromStream, IltmmCapture::SaveSettingsToStream |
|
Topics: |
Example
For a C example, refer to IltmmCapture::CanSaveObjectSettings Example for C.
For a C++ example, refer to IltmmCapture::CanSaveObjectSettings Example for C++.