KsGetNextSibling function (ks.h)

The KsGetNextSibling function returns the next sibling of a given object.

Syntax

KSDDKAPI PVOID KsGetNextSibling(
  [in] PVOID Object
);

Parameters

[in] Object

The object for which to find the next sibling.

Return value

KsGetNextSibling returns the next sibling object of Object. If no such sibling object exists, it returns NULL.

Remarks

If Object is a filter factory, KsGetNextSibling returns the next filter factory belonging to the parent device, and so on. Callers must perform appropriate typecasting to and from PVOID.

The object hierarchy is guaranteed stable only while the appropriate mutex is held, in this case the device mutex. For more information, see AVStream Overview and Mutexes in AVStream.

Minidrivers rarely call KsGetNextSibling directly. There are a number of functions that are inline calls to KsGetNextSibling and that perform the typecasting for you: KsFilterFactoryGetNextSiblingFilterFactory, KsFilterGetNextSiblingFilter, and KsPinGetNextSiblingPin.

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 PASSIVE_LEVEL

See also

KSFILTER

KSFILTERFACTORY

KSPIN

KsFilterFactoryGetNextSiblingFilterFactory

KsFilterGetNextSiblingFilter

KsPinGetNextSiblingPin