KsGateTurnInputOn function (ks.h)

Article
02/22/2024

The KsGateTurnInputOn function turns on an existing input to Gate.

Syntax

void KsGateTurnInputOn(
  [in, optional] PKSGATE Gate
);

Parameters

[in, optional] Gate

A pointer to a KSGATE structure representing the gate that currently has an input in the OFF state to transition to the ON state. May be an AND gate or an OR gate.

Return value

None

Remarks

It is the minidriver's responsibility to verify that the gate that the minidriver passes to KsGateTurnInputOn has at least one OFF input. If you call this function with an AND gate that has no inputs currently in the OFF state, the call sets the AND gate into an invalid state. If you call this function with an OR gate that has no inputs currently in the OFF state, the result is equivalent to adding another input in the ON state to Gate.

Furthermore, if turning an input on would cause Gate to transition from the closed state to the open state, this call instead turns on an input to whatever gate is attached to Gate. For more information, see Flow Control Gates in AVStream.

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	Desktop
Header	ks.h (include Ks.h)
IRQL	Any level

Share via