KsStreamPointerGetIrp function (ks.h)

Article
03/15/2022

The KsStreamPointerGetIrp function returns the IRP associated with the frame that is referenced by the given stream pointer.

Syntax

KSDDKAPI PIRP KsStreamPointerGetIrp(
  [in]            PKSSTREAM_POINTER StreamPointer,
  [out, optional] PBOOLEAN          FirstFrameInIrp,
  [out, optional] PBOOLEAN          LastFrameInIrp
);

Parameters

[in] StreamPointer

A pointer to the KSSTREAM_POINTER structure that references the frame for which the associated IRP is returned.

[out, optional] FirstFrameInIrp

A pointer to a caller-supplied BOOLEAN value set to TRUE on return if the frame referenced by StreamPointer is the first frame in the returned IRP and FALSE if not. If NULL, AVStream does not test this condition.

[out, optional] LastFrameInIrp

A pointer to a caller-supplied BOOLEAN value set to TRUE if the frame referenced by the stream pointer is the last frame in the returned IRP and FALSE if not. If NULL, AVStream does not test this condition.

Return value

KsStreamPointerGetIrp returns either a pointer to the IRP associated with the frame that is referenced by the given stream pointer, or returns NULL. A return value of NULL indicates that the stream pointer is not locked.

Remarks

KsStreamPointerGetIrp can also be used to determine if StreamPointer references the first and/or last frame contained in the returned IRP.

StreamPointer must be locked in order for KsStreamPointerGetIrp to execute successfully. Any attempt to call this function with an unlocked stream pointer results in a NULL return value.

FirstFrameInIrp and/or LastFrameInIrp must be non-NULL at call-time in order for AVStream to fill in these values.

Also see Stream Pointers.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib
IRQL	<=DISPATCH_LEVEL