KsGateTurnInputOff function (ks.h)

Article
02/22/2024

The KsGateTurnInputOff function turns off an existing input to Gate.

Syntax

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

Parameters

[in, optional] Gate

A pointer to a KSGATE structure that is the gate to transition to the OFF state. Must currently have an input in 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 KsGateTurnInputOff has at least one ON input. If you call this function with an OR gate that has no inputs currently in the ON state, the call sets the OR gate into an invalid state. If you call this function with an AND gate that has no inputs currently in the ON state, the result is equivalent to adding another input in the OFF state to Gate.

Furthermore, if turning an input off would cause Gate to transition from the open state to the closed state, this call instead turns off 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