Edit

Share via

IFilterMapper::RegisterPin method (strmif.h)

  • Article

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

Note  The IFilterMapper interface is deprecated. Use IFilterMapper2 instead.
 
Records the details of the pin in the registry.

Syntax

HRESULT RegisterPin(
  [in] CLSID   Filter,
  [in] LPCWSTR Name,
  [in] BOOL    bRendered,
  [in] BOOL    bOutput,
  [in] BOOL    bZero,
  [in] BOOL    bMany,
  [in] CLSID   ConnectsToFilter,
  [in] LPCWSTR ConnectsToPin
);

Parameters

[in] Filter

GUID of the filter.

[in] Name

Name of the pin. This should be unique within the filter. It has no significance other than to indicate type information. You should not use pin names longer than 99 characters, because this causes filter enumeration problems.

[in] bRendered

Value specifying whether the filter renders this input. Set to TRUE if it does; otherwise, set to FALSE.

[in] bOutput

Value specifying whether this is an output pin. Set to TRUE if it is; otherwise, set to FALSE.

[in] bZero

Value specifying whether the filter can have zero instances of this pin. If it can, set to TRUE; otherwise, set to FALSE. For example, a decompression filter doesn't need to create a sound output pin for a movie without a sound track.

[in] bMany

Value specifying whether the filter can have many instances of this pin. If it can, set to TRUE; otherwise, set to FALSE. For example, a mixer might have multiple instances of its input pin.

[in] ConnectsToFilter

Reserved. Must be NULL. (This is intended for filters such as system-wide mixers that have connections outside the filter graph. It is not yet implemented.)

[in] ConnectsToPin

Reserved. Must be NULL.

Return value

Returns an HRESULT value.

Requirements

Requirement Value
Target Platform Windows
Header strmif.h (include Dshow.h)

See also

Error and Success Codes

IFilterMapper Interface