KsGetFirstChild function

The KsGetFirstChild function returns the first AVStream child object of Object.

Syntax


PVOID KsGetFirstChild(
  _In_ PVOID Object
);

Parameters

Object [in]

The object for which to find the first AVStream child object.

Return value

KsGetFirstChild returns the first AVStream child object of Object. If no such child object exists, it returns NULL.

Remarks

To see the hierarchical organization of AVStream objects, see AVStream Object Hierarchy.

Minidrivers rarely call this function directly. Those that do must manually perform typecasts to and from PVOID. There are a number of functions that are inline calls to KsGetFirstChild and perform typecasts for you: KsDeviceGetFirstChildFilterFactory and KsFilterFactoryGetFirstChildFilter. Note that the object hierarchy is only guaranteed stable while the appropriate mutex is held, in this case the device mutex. For more information, see Mutexes in AVStream.

Requirements

Target platform

Universal

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

Library

Ks.lib

IRQL

PASSIVE_LEVEL

See also

KsGetParent
KsDeviceGetFirstChildFilterFactory
KsFilterFactoryGetFirstChildFilter
KsFilterGetFirstChildPin

 

 

Send comments about this topic to Microsoft

Show: