Unit 'exec' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#os4units]

Deallocate

Free a block of memory

Declaration

Source position: exec.pas line 1761

procedure Deallocate(

  MemHeader: PMemHeader;

  MemoryBlock: Pointer;

  ByteSize: LongWord

);

Arguments

MemoryBlock

  

Address of memory block to free

ByteSize

  

Number of bytes to free. nil is allowed and does nothing

Description

This function deallocates memory by returning it to the appropriate private free memory pool. This function can be used to free an entire block allocated with the above function, or it can be used to free a sub-block of a previously allocated block. Sub-blocks must be an even multiple of the memory chunk size (currently 8 bytes).

This function can even be used to add a new free region to an existing MemHeader, however the extent pointers in the MemHeader will no longer be valid.

If memoryBlock is not on a block boundary then it will be rounded down in a manner compatible with Allocate(). Note that this will work correctly with all the memory allocation functions, but may cause surprises if one is freeing only part of a region. The size of the block will be rounded up, so the freed block will fill to an even memory block boundary.

See also

Allocate

  

Allocate a block of memory


Documentation generated on: 2021-07-30