KSHANDSHAKE structure (ks.h)

The KSHANDSHAKE structure is used to pass information back and forth while pins are handshaking in an attempt to negotiate a private interface.

Syntax

typedef struct {
  GUID  ProtocolId;
  PVOID Argument1;
  PVOID Argument2;
} KSHANDSHAKE, *PKSHANDSHAKE;

Members

ProtocolId

This member specifies the GUID that represents the interface or protocol being negotiated between two AVStream pins.

Argument1

A pointer to an interface-dependent argument. Most often, this is used to pass back and forth COM-style interface pointers once a specific private interface or protocol has been agreed upon.

Argument2

A pointer to an interface-dependent argument.

Remarks

See KsPinHandshake for more information about negotiating private interfaces between AVStream pins.

Pin handshaking is a concept that is usable only between two pins that support IOCTL_KS_HANDSHAKE. Currently, only AVStream pins support this interface; thus this is only useful for negotiating private interfaces between two AVStream pins. Currently, connections between AVStream pins are negotiated via this mechanism.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows XP and later operating systems and in Microsoft DirectX 8.0 and later versions.
Header	ks.h (include Ks.h)

See also

IOCTL_KS_HANDSHAKE

KsPinHandshake