JCL Help:PathToPidl
JCL Help: PathToPidl Function
Search in JCL Help
Search in all projects
Summary
Converts a path to an item identifier list.
Pascal
function PathToPidl(const Path: string; Folder: IShellFolder): PItemIdList;
Parameters
| Parameters | Description |
| const Path: string | The fully qualified path to convert to an item identifier list |
| Folder: IShellFolder | The folder that the returned pidl must be relative to. If you specify nil then the returned pidl will be relative to the desktop. |
Return Value
If the function succeeds the return value is the item identifier list of the specified path, relative to the specified Folder. If the function fails the return value is nil. Note that the caller is responsible for eventually releasing the memory associated with the returned pidl by calling PidlFree.
Description
PathToPidl converts the supplied path to an item identifier list relative to the folder given by the Folder parameter. If the Folder parameter is nil then the resulting item identifier list will be relative to the desktop, in other words: it's an absolute item identifier list. If the function fails the result is nil.
See Also
About
Unit
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
