In This Topic ▼

IltmmMediaInfo::put_SourceFile

Summary

Sets the name of the current source media file.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmMediaInfo_put_SourceFile.htm(pMediaInfo, newVal)
C++	HRESULT put_SourceFile(newVal)

Parameters

IltmmMediaInfo *pMediaInfo

Pointer to an IltmmMediaInfo Interface.

BSTR newVal

String that contains the name of the source media file to set.

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 current source media file, set using this function, is the file for which the IltmmMediaInfo interface/object gets information.

This function must be called before calling most of the other IltmmMediaInfo function used for retrieving information. If IltmmMediaInfo::get_OutputStreams is called before IltmmMediaInfo::put_SourceFile is called, IltmmMediaInfo::get_OutputStreams will update the Stream parameter with 0 and return S_OK. If any of the other IltmmMediaInfo functions are called before IltmmMediaInfo::put_SourceFile is called, they will return an error.

To get the current source media file, call IltmmMediaInfo::get_SourceFile.

Call IltmmMediaInfo::ResetSource to release the source file when it is no longer needed.