PFNALLOCATOR_ALLOCATEFRAME callback function (ks.h)

Article
02/22/2024

The KStrAllocateFrame routine describes a vendor-supplied frame allocation function.

Syntax

PFNALLOCATOR_ALLOCATEFRAME PfnallocatorAllocateframe;

NTSTATUS PfnallocatorAllocateframe(
  [in]  PFILE_OBJECT FileObject,
  [out] PVOID *Frame
)
{...}

Parameters

[in] FileObject

Pointer to a FILE_OBJECT structure for which to allocate frames.

[out] Frame

A pointer to a caller-allocated buffer in which the new frame is returned.

Return value

Returns STATUS_SUCCESS if the request is handled. Otherwise returns an appropriate error code.

Remarks

This type is used in the AllocateFrame member of the KSSTREAMALLOCATOR_FUNCTIONTABLE structure.

You can pass an instance of this structure as part of a KSPROPERTY_STREAMALLOCATOR_FUNCTIONTABLE property request.

Requirements

Requirement	Value
Target Platform	Desktop
Header	ks.h (include Ks.h)