IResourceManager::Register 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 Register method registers a single named resource with the resource manager.

Syntax

HRESULT Register(
  [in]  LPCWSTR pName,
  [in]  LONG    cResource,
  [out] LONG    *plToken
);

Parameters

[in] pName

Named resource.

[in] cResource

Number of resources.

[out] plToken

Pointer to the returned token identifying the resource to be used in additional calls.

Return value

Returns an HRESULT value that depends on the implementation. HRESULT can be one of the following standard constants, or other values not listed.

Return code Description
E_FAIL
Failure.
E_POINTER
NULL pointer argument.
E_INVALIDARG
Invalid argument.
E_NOTIMPL
Method isn't supported.
S_OK or NOERROR
Success.

Remarks

This method registers a named resource, which can contain a number of resources, and returns a token to be used when requesting this resource. It is not an error if the resource is already registered; if the number in the cResource parameter is less than what is already registered, resources will be deallocated to the new count. To unregister the resource, pass a count of zero in cResource.

Requirements

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

See also

Error and Success Codes

IResourceManager Interface