IVPManager::SetVideoPortIndex method (strmif.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 SetVideoPortIndex method instructs the Video Port Manager (VPM) to connect to the specified video port.

Syntax

HRESULT SetVideoPortIndex(
  [in] DWORD dwVideoPortIndex
);

Parameters

[in] dwVideoPortIndex

Double word containing the video port index.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

Use this method on a multi-monitor system to specify to the Video Port Manager which video port index is being used.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header strmif.h (include Dshow.h)
Library Strmiids.lib

See also

Error and Success Codes

IVPManager Interface

IVPManager::GetVideoPortIndex