IKsPin::KsCreateSinkPinHandle method (ksproxy.h)

Article
10/21/2021

The KsCreateSinkPinHandle method creates a pin handle and stores it in the KS pin object.

Syntax

HRESULT KsCreateSinkPinHandle(
  [in] KSPIN_INTERFACE & Interface,
  [in] KSPIN_MEDIUM &    Medium
);

Parameters

[in] Interface

A type reference to a KSPIN_INTERFACE structure for the interface that KsCreateSinkPinHandle negotiated for the created pin.

[in] Medium

A type reference to a KSPIN_MEDIUM structure for the medium that KsCreateSinkPinHandle negotiated for the created pin.

Return value

Returns NOERROR if successful; otherwise, returns an error code.

Remarks

Since the KsCreateSinkPinHandle method uses pass-by-reference variables, it is not necessary to pass pointers to KSPIN_INTERFACE and KSPIN_MEDIUM structures as arguments.

After KsCreateSinkPinHandle has created a pin handle, you can retrieve the handle by calling the IKsObject::KsGetObjectHandle method.

This method is for proxy use and is not recommended for application use.

Requirements

Requirement	Value
Target Platform	Desktop
Header	ksproxy.h (include Ksproxy.h)