KsFilterFactoryAddCreateItem function (ks.h)

Article
03/15/2022

The KsFilterFactoryAddCreateItem function adds a new create item for the specified filter factory.

Syntax

KSDDKAPI NTSTATUS KsFilterFactoryAddCreateItem(
  [in]           PKSFILTERFACTORY     FilterFactory,
  [in]           PWSTR                RefString,
  [in, optional] PSECURITY_DESCRIPTOR SecurityDescriptor,
  [in]           ULONG                CreateItemFlags
);

Parameters

[in] FilterFactory

A pointer to a KSFILTERFACTORY structure representing the filter factory to which to add a new create item.

[in] RefString

A pointer to a Unicode text string that identifies the create item.

[in, optional] SecurityDescriptor

This parameter optionally contains a pointer to a SECURITY_DESCRIPTOR structure for this type of object. See the Microsoft Windows SDK For information about this structure. For related information, see KSOBJECT_CREATE_ITEM. If NULL, no descriptor is assigned.

[in] CreateItemFlags

See the table for the Flags member of KSOBJECT_CREATE_ITEM.

Return value

KsFilterFactoryAddCreateItem returns success or failure of the attempt to add a new create item.

Remarks

Normally, only a single create item using the reference GUID supplied in the filter descriptor is added for the filter factory. This function allows the caller to add create items associated with the given filter factory.

For more information, see Initializing an AVStream Minidriver.

Requirements

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