IltmmMediaInfo::get_SourceFormatName

#include "ltmm.h"

C Syntax

HRESULT IltmmMediaInfo__get_SourceFormatName(pMediaInfo, SrcFormatName)

C++ Syntax

HRESULT get_SourceFormatName(SrcFormatName)

 

IltmmMediaInfo *pMediaInfo;

/* pointer to an interface */

BSTR * SrcFormatName;

/* pointer to a string */

Retrieves the name of the format of the current source media file.

Parameter

Description

pMediaInfo

Pointer to an IltmmMediaInfo Interface.

SrcFormatName

Pointer to a variable to be updated with the name of the format of the 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

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

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

The current source media file, set using IltmmMediaInfo::put_SourceFile, is the file for which the IltmmMediaInfo interface/object gets information. This function must be called before calling any of the other IltmmMediaInfo functions used for retrieving information.

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.

Platforms

Win32, x64

See Also

Elements:

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

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