KsFilterFactoryAddCreateItem function

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

Syntax


NTSTATUS KsFilterFactoryAddCreateItem(
  _In_     PKSFILTERFACTORY     FilterFactory,
  _In_     PWSTR                RefString,
  _In_opt_ PSECURITY_DESCRIPTOR SecurityDescriptor,
  _In_     ULONG                CreateItemFlags
);

Parameters

FilterFactory [in]

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

RefString [in]

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

SecurityDescriptor [in, optional]

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.

CreateItemFlags [in]

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

Target platform

Universal

Version

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Header

Ks.h (include Ks.h)

Library

Ks.lib

See also

KSOBJECT_CREATE_ITEM
KsAllocateObjectCreateItem
KsAddObjectCreateItemToDeviceHeader
KsAddObjectCreateItemToObjectHeader
KsFreeObjectCreateItem
KsQueryObjectCreateItem

 

 

Send comments about this topic to Microsoft

Show: