Share via


IEnumPIDMap::Next method (bdaiface.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 Next method retrieves the next n elements in the collection.

Syntax

HRESULT Next(
  [in]      ULONG   cRequest,
  [in, out] PID_MAP *pPIDMap,
  [out]     ULONG   *pcReceived
);

Parameters

[in] cRequest

The number of elements to retrieve.

[in, out] pPIDMap

Address of an array allocated by the caller, containing cRequest elements. The array is filled with PID_MAP structures that describe the PID mapping.

[out] pcReceived

Pointer to a variable that receives the number of elements actually retrieved. This parameter cannot be NULL. If cRequest equals zero, this parameter receives the total number of items in the collection.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_INVALIDARG
Invalid argument; pPidMap and pcReceived cannot be NULL.
S_FALSE
Reached the end of the collection.
S_OK
Success.

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 bdaiface.h
Library Strmiids.lib

See also

Error and Success Codes

IEnumPIDMap Interface