KsPinHandshake function

The KsPinHandshake function attempts a protocol handshake with a connected pin.

Syntax

KSDDKAPI NTSTATUS KsPinHandshake(
  PKSPIN       Pin,
  PKSHANDSHAKE In,
  PKSHANDSHAKE Out
);

Parameters

Pin

A pointer to the KSPIN structure that is initiating the handshake. The handshake request is passed on to the pin connected to this object.

In

A pointer to the KSHANDSHAKE structure containing the handshake information to be passed to the connected pin.

Out

A pointer to a KSHANDSHAKE structure that is filled in with handshake information by the connected pin.

Return Value

KsPinHandshake returns STATUS_SUCCESS if the connected pin is accepting the negotiated connection. Otherwise, it returns an appropriate error code.

Remarks

Protocol handshakes can be used to negotiate private interfaces between two pins that are both AVStream pins.

Connections between AVStream pins are performed using this type of handshake.

Requirements

   
Windows version 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 PASSIVE_LEVEL

See Also

IOCTL_KS_HANDSHAKE

KSHANDSHAKE

KsPinGetConnectedPinInterface