Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 2.86 KB

nf-storport-storportallocatepool.md

File metadata and controls

90 lines (66 loc) · 2.86 KB
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:storport.StorPortAllocatePool
StorPortAllocatePool function (storport.h)
The StorPortAllocatePool routine allocates a block of non-contiguous, non-paged pool memory.
storage\storportallocatepool.htm
storage
07/19/2019
StorPortAllocatePool function
StorPortAllocatePool, StorPortAllocatePool routine [Storage Devices], storage.storportallocatepool, storport/StorPortAllocatePool, storprt_4ede181d-6ccf-47af-974d-b0daaa6e723a.xml
storport.h
Storport.h
Universal
StorPortAllocatePool2, StorPortIrql
<=DISPATCH_LEVEL
Windows
StorPortAllocatePool
storport/StorPortAllocatePool
APIRef
kbSyntax
HeaderDef
storport.h
StorPortAllocatePool

StorPortAllocatePool function

-description

The StorPortAllocatePool routine allocates a block of non-contiguous, non-paged pool memory.

-parameters

-param HwDeviceExtension [in]

A pointer to the hardware device extension for the host bus adapter (HBA).

-param NumberOfBytes [in]

The size, in bytes, of the block of memory being allocated.

-param Tag [in]

The pool tag for the allocated memory. Drivers specify the pool tag as a string of four ASCII characters, delimited by single quotation marks. The string is usually specified in reverse order.

-param BufferPointer [out]

A pointer to the address of the allocated memory block or NULL if not successful.

-returns

StorPortAllocatePool returns one of the following status codes:

Return code Description
STOR_STATUS_NOT_IMPLEMENTED This function is not implemented on the active operating system.
STOR_STATUS_SUCCESS Indicates that the routine successfully allocated a memory block of the requested size.
STOR_STATUS_INVALID_PARAMETER The pointer to receive the buffer address is NULL.
STOR_STATUS_INVALID_IRQL The call was made at an invalid IRQL.
STOR_STATUS_INSUFFICIENT_RESOURCES Unable to allocate memory of the requested size.

-remarks

A miniport driver calls the StorPortAllocatePool routine to allocate a block of non-contiguous memory from the non-paged pool. To free the block of memory, the miniport driver calls StorPortFreePool. If the request fails, BufferPointer will be set to NULL.

-see-also

StorPortFreePool