Share via


IConfigAsfWriter::GetIndexMode method (dshowasf.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetIndexMode method retrieves the current index mode.

Syntax

HRESULT GetIndexMode(
  [out] BOOL *pbIndexFile
);

Parameters

[out] pbIndexFile

Receives the index mode setting. A value of TRUE indicates that the WM ASF Writer is configured to write indexed files.

Return value

Returns S_OK if successful, or an HRESULT error code otherwise.

Remarks

Use this method to determine whether the WM ASF Writer is currently configured to write indexed ASF files. For more information, see IConfigAsfWriter::SetIndexMode.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header dshowasf.h

See also

Creating ASF Files in DirectShow

Error and Success Codes

IConfigAsfWriter Interface