KsPinPropertyHandler function

The KsPinPropertyHandler function performs standard handling of the static members of the KSPROPSETID_Pin property set. This handling does not include KSPROPERTY_PIN_CINSTANCES or KSPROPERTY_PIN_DATAINTERSECTION.

Syntax


NTSTATUS KsPinPropertyHandler(
  _In_          PIRP             Irp,
  _In_          PKSPROPERTY      Property,
  _Inout_       PVOID            Data,
  _In_          ULONG            DescriptorsCount,
  _In_    const KSPIN_DESCRIPTOR *Descriptor
);

Parameters

Irp [in]

Specifies the IRP handling the connection request.

Property [in]

Specifies the specific property information.

Data [in, out]

Specifies the data parameter mapped to a system address. This is the same parameter passed to a property handler through a KsPropertyHandler callback.

DescriptorsCount [in]

Specifies the number of pin descriptors being passed.

Descriptor [in]

Specifies the pointer to the list of pin descriptors.

Return value

The KsPinPropertyHandler function returns STATUS_SUCCESS or an error specific to the property being handled. The function fills in the IO_STATUS_BLOCK.Information field of the PIRP.IoStatus element within the IRP. It does not set the IO_STATUS_BLOCK.Status field nor complete the IRP.

Remarks

Do not use the KsPinPropertyHandler function to define a pin property set; a pin property set can be more easily defined using the DEFINE_KSPROPERY_PINSET macro.

Requirements

Target platform

Universal

Header

Ks.h (include Ks.h)

Library

Ks.lib

 

 

Send comments about this topic to Microsoft

Show: