mstxMemHeapUnregister

Function Description

Deregisters the regions associated with a memory pool when the memory pool is deregistered.

Function Prototype

void mstxMemHeapUnregister(mstxDomainHandle_t domain, mstxMemHeapHandle_t heap)

Parameters

**Table 1** Parameters
Parameter	Input/Output	Description
domain	Input	domain indicates the domain to which the memory pool belongs. The value can be globalDomain or the handle returned by mstxDomainCreateA. Data type: const char *
heap	Input	heap indicates the handle to the memory pool to be deregistered. It is the return value of mstxMemHeapRegister. struct mstxMemHeap_st; typedef struct mstxMemHeap_st mstxMemHeap_t; typedef mstxMemHeap_t* mstxMemHeapHandle_t;

Returns

None

Calling Example

mstxMemHeapDesc_t heapDesc{};
mstxMemHeapHandle_t memPool = mstxMemHeapRegister(globalDomain, &heapDesc); // Register the memory pool.
...
mstxMemHeapUnregister(globalDomain, memPool);                        // Deregister the memory pool.