JCL Help:PidlFree

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Frees the given item identifier list.


Pascal

 function PidlFree(var IdList: PItemIdList): Boolean;


Parameters

Parameters Description
var IdList: PItemIdList The item identifier list whose associated memory shall be freed.


Return Value

If the function succeeds the return value is True and IdList is set to nil. If the function fails the return value is False and the IdList parameter will retain its value.


Description

PidlFree frees the memory associated with the item identifier list given by IdList. If the memory was successfully freed the IdList is set to nil and the function returns True. If the memory could not be freed the result is False. This function assumes that the memory associated with the item identifier was allocated by the Shell's memory allocator and will fail if this is not the case.


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