KsGateTurnInputOff
TOC
Collapse the table of content
Expand the table of content

KsGateTurnInputOff function

The KsGateTurnInputOff function turns off an existing input to Gate.

Syntax


void __inline KsGateTurnInputOff(
  _In_opt_ PKSGATE Gate
);

Parameters

Gate [in, optional]

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

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

KsGateTurnInputOn
KsGateAddOnInputToAnd
KsGateAddOnInputToOr
KsGateAddOffInputToAnd
KsGateAddOffInputToOr
KsGateRemoveOnInputFromAnd
KsGateRemoveOnInputFromOr
KsGateRemoveOffInputFromAnd
KsGateRemoveOffInputFromOr
KSGATE

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft