KsGetMultiplePinFactoryItems function (ksproxy.h)

Article
10/21/2021

The KsGetMultiplePinFactoryItems function retrieves pin property items in a variable length data buffer.

Syntax

KSDDKAPI HRESULT KsGetMultiplePinFactoryItems(
  [in]  HANDLE FilterHandle,
  [in]  ULONG  PinFactoryId,
  [in]  ULONG  PropertyId,
  [out] PVOID  *Items
);

Parameters

[in] FilterHandle

Handle to the filter that contains the pin factory to query.

[in] PinFactoryId

Identifier of the pin factory against which the property items are being returned.

[in] PropertyId

Identifier of the property in the pin property set (KSPROPSETID_Pin) to query.

[out] Items

Pointer to a buffer to receive the property items. If successfully retrieved, this pointer must be subsequently deleted with the CoTaskMemFree function.

Return value

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

Remarks

The KsGetMultiplePinFactoryItems function queries for the data size, in bytes, of the requested property, allocates a buffer, and retrieves the data.

For more information about CoTaskMemFree, see the Microsoft Windows SDK documentation.

Requirements

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