KsPinPropertyHandler function (ks.h)

Article
02/22/2024

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

KSDDKAPI NTSTATUS KsPinPropertyHandler(
  [in]      PIRP                   Irp,
  [in]      PKSPROPERTY            Property,
  [in, out] PVOID                  Data,
  [in]      ULONG                  DescriptorsCount,
  [in]      const KSPIN_DESCRIPTOR *Descriptor
);

Parameters

[in] Irp

Specifies the IRP handling the connection request.

[in] Property

Specifies the specific property information.

[in, out] Data

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

[in] DescriptorsCount

Specifies the number of pin descriptors being passed.

[in] Descriptor

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

Requirement	Value
Target Platform	Universal
Header	ks.h (include Ks.h)
Library	Ks.lib

Share via