Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 3.57 KB

nf-ks-kscreatedefaultallocatorex.md

File metadata and controls

91 lines (63 loc) · 3.57 KB
Raw
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:ks.KsCreateDefaultAllocatorEx
KsCreateDefaultAllocatorEx function (ks.h)
Creates a default allocator that uses the specified memory pool and associates the IoGetCurrentIrpStackLocation(pIrp)->FileObject with this allocator using an internal dispatch table (KSDISPATCH_TABLE).
stream\kscreatedefaultallocatorex.htm
stream
06/25/2020
KsCreateDefaultAllocatorEx function
KsCreateDefaultAllocatorEx, KsCreateDefaultAllocatorEx function [Streaming Media Devices], ks/KsCreateDefaultAllocatorEx, ksfunc_99b91933-c8d3-4580-bd51-a6620defcf30.xml, stream.kscreatedefaultallocatorex
ks.h
Ks.h
Universal
Ks.lib
Windows
KsCreateDefaultAllocatorEx
ks/KsCreateDefaultAllocatorEx
APIRef
kbSyntax
LibDef
Ks.lib
Ks.dll
KsCreateDefaultAllocatorEx

KsCreateDefaultAllocatorEx function

-description

Creates a default allocator that uses the specified memory pool and associates the IoGetCurrentIrpStackLocation(pIrp)->FileObject with this allocator using an internal dispatch table (KSDISPATCH_TABLE).

-parameters

-param Irp [in]

Contains the IRP with the allocator create request being handled.

-param InitializeContext [in, optional]

Optionally contains a context to use with an external allocator. This is only used as the initialization context to the optional InitializeAllocator callback when creating an allocator context. The parameter is not otherwise used. If an external allocator is not provided, this parameter must be set to NULL.

-param DefaultAllocate [in, optional]

Optionally contains an external allocate function that is used in place of the default pool allocation. If this is NULL, default allocation is used.

-param DefaultFree [in, optional]

Optionally contains an external free function that is used in place of the default pool allocation. If an external allocator is not provided, this parameter must be set to NULL.

-param InitializeAllocator [in, optional]

Optionally contains an external allocator initialization function to which the InitializeContext parameter is passed. This function is expected to return an allocator context based on the allocator framing. If an external allocator is not provided, this parameter must be set to NULL.

-param DeleteAllocator [in, optional]

Optionally contains an external allocator delete function that is used for external allocators. If an external allocator is not provided, this parameter must be set to NULL.

-returns

Returns STATUS_SUCCESS, else an error on default allocator creation failure. Does not complete the IRP or set the status in the IRP.

-remarks

Before calling this routine, the KSCREATE_ITEM_IRP_STORAGE(Irp) macro should return a pointer to the KSOBJECT_CREATE_ITEM structure that is the create item for this allocator. KsCreateDefaultAllocatorEx sets FsContext to point to the return value of this macro. As such, FsContext can later be used for security descriptor queries or changes.

You can find KSCREATE_ITEM_IRP_STORAGE(Irp) and related macros in ks.h.