JCL Help:PathToPidlBind

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Converts a path to an item identifier list and binds to its parent folder.


Pascal

 function PathToPidlBind(const FileName: string; out Folder: IShellFolder): PItemIdList;


Parameters

Parameters Description
const FileName: string The fully qualified name of the file or folder you want to bind to.
out Folder: IShellFolder On successful return contains a reference to the parent folder of the specified item.


Return Value

If the function succeeds the return value is the item identifier list of the specified FileName, relative to the returned 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

PathToPidlBind converts the supplied path given by FileName to an item identifier list and binds to the parent folder of this item. The item identifier list is returned as the function result and the bound folder is returned in the Folder parameter. If the function fails both result and the Folder are set to nil.


See Also

PathToPidl PidlToPath DriveToPidlBind


About

Unit

JclShell


Donator

Marcel van Brakel


Notes

This function will correctly handle drives but you should use DriveToPidlBind


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