IltmmMediaInfo::put_SourceFile

#include "ltmm.h"

C Syntax

HRESULT IltmmMediaInfo_put_SourceFile(pMediaInfo, File)

C++ Syntax

HRESULT put_SourceFile(File)

 

IltmmMediaInfo *pMediaInfo;

/* pointer to an interface */

BSTR File;

/* file name */

Sets the name of the current source media file.

Parameter

Description

pMediaInfo

Pointer to an IltmmMediaInfo Interface.

File

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

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 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.

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:

IltmmMediaInfo interface, IltmmMediaInfo::get_SourceFile, IltmmMediaInfo::get_SourceFilter, IltmmMediaInfo::get_SourceFilterClassID, IltmmMediaInfo::get_SourceFilterDispatch, IltmmMediaInfo::get_SourceMediaType, IltmmMediaInfo::get_SourceFormat, IltmmMediaInfo::get_SourceFormatName

Topics:

Multimedia Function Group
Media File Information

Example

For a C example, refer to Retrieving Media File Information for C.

For a C++ example, refer to Retrieving Media File Information for C++.