KsGateTurnInputOn function

The KsGateTurnInputOn function turns on an existing input to Gate.

Syntax


void __inline KsGateTurnInputOn(
  _In_opt_ PKSGATE Gate
);

Parameters

Gate [in, optional]

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

Target platform

Version

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

Header

Ks.h (include Ks.h)

IRQL

Any level

See also

KsGateTurnInputOff
KsGateAddOnInputToAnd
KsGateAddOnInputToOr
KsGateAddOffInputToAnd
KsGateAddOffInputToOr
KsGateRemoveOnInputFromAnd
KsGateRemoveOnInputFromOr
KsGateRemoveOffInputFromAnd
KsGateRemoveOffInputFromOr
KSGATE

 

 

Send comments about this topic to Microsoft

Show: