IltmmMediaInfo::get_SourceFile

#include "ltmm.h"

C Syntax

HRESULT IltmmMediaInfo__get_SourceFile(pMediaInfo, File)

C++ Syntax

HRESULT get_SourceFile(File)

 

IltmmMediaInfo *pMediaInfo;

/* pointer to an interface */

BSTR *File;

/* pointer to a string */

Retrieves the name of the current source media file.

Parameter

Description

pMediaInfo

Pointer to an IltmmMediaInfo Interface.

File

Pointer to a string to be updated with the name of the current source media file.

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

This function retrieves the name of the source media file set using IltmmMediaInfo::put_SourceFile.

To set the current source media file, call IltmmMediaInfo::put_SourceFile.

Call SysFreeString to free the memory allocated for the string when it is no longer needed.

The current source media file is the file for which the IltmmMediaInfo interface/object gets information.

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:

IltmmMediaInfo interface, IltmmMediaInfo::put_SourceFile, IltmmMediaInfo::get_SourceFilter, IltmmMediaInfo::get_SourceFilterClassID, IltmmMediaInfo::get_SourceFilterDispatch, IltmmMediaInfo::get_SourceMediaType, IltmmMediaInfo::get_SourceFormat, IltmmMediaInfo::get_SourceFormatName, IltmmMediaInfo::get_SourceFileSize, IltmmMediaInfo::get_SourceBitRate, IltmmMediaInfo::get_SourceDuration

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