IRenderEngine::SetSourceNameValidation method

[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

[Deprecated. This API may be removed from future releases of Windows.]

 

The SetSourceNameValidation method specifies how the render engine validates file names.

Syntax

HRESULT SetSourceNameValidation(
   BSTR          FilterString,
   IMediaLocator *pOverride,
   LONG          Flags
);

Parameters

FilterString

BSTR value containing pairs of filter strings, formatted as required by the lpstrFilter member of the OPENFILENAME structure. The media locator uses this filter if it presents an Open File dialog box to the end user.

pOverride

Optional pointer to the IMediaLocator interface of a media locator to use in place of the default. To use the default media locator, set the value of this parameter to NULL. See Remarks for more information.

Flags

Bitwise combination of File Name Validation Flags specifying the behavior of the media locator. The SFN_VALIDATEF_CHECK flag must be present. The SFN_VALIDATEF_hlinkMUTED flag has no effect with this method.

Return value

Returns one of the following HRESULT values:

Return code	Description
S_OK	Success.
E_MUST_INIT_RENDERER	Render engine failed to initialize.

 

Remarks

Using the pOverride parameter, you can supply your own custom implementation of the IMediaLocator interface. For example, the default media locator does not notify an application about the files that it finds (or cannot find). To get around this limitation, you could implement a custom media locator, making it a wrapper for the default version. Then pass IMediaLocator::FindMediaFile calls directly to the default version and examine the return value.

Currently, this method does not validate dynamically loaded sources. See IRenderEngine::SetDynamicReconnectLevel.

Note

The header file Qedit.h is not compatible with Direct3D headers later than version 7.

 

Note

To obtain Qedit.h, download the Microsoft Windows SDK Update for Windows Vista and .NET Framework 3.0. Qedit.h is not available in the Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 Service Pack 1.

 

Requirements

Requirement	Value
Header	Qedit.h
Library	Strmiids.lib

See also

IRenderEngine Interface

Error and Success Codes