JCL Help:SHFreeMem

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Frees the memory pointed to by P.


Pascal

 function SHFreeMem(var P: Pointer): Boolean;


Parameters

Parameters Description
var P: Pointer Pointer to the memory block to free. If the function succeeds this parameter is set to nil.


Return Value

If the function succeeds it returns True, if it fails it returns False. The latter case means that either the shell's memory allocator couldn't be retrieved or that the memory block wasn't allocated by the shell. Either case, the memory is not freed and the P parameter retains its value.


Description

SHFreeMem frees the memory pointed to by P in the Shell's memory space. The memory must be allocated by the Shell's memory allocator. On success P is set to nil and the return value is True. On failure P retains its value and the return value is False.


See Also

SHAllocMem SHGetMem


About

Unit

JclShell


Donator

Marcel van Brakel


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page