JCL Help:PidlGetLength

 JCL Help: PidlGetLength Function

Windows_Specific.Shell.PathsandPIDLs

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Returns the length of the given item identifier list.

Pascal

 function PidlGetLength(Pidl: PItemIdList): Integer;

Parameters

Parameters	Description
Pidl: PItemIdList	The item identifier list for which to calculate the length.

Return Value

The length, in bytes, of the item identifier list. If the supplied pidl is either unassigned or empty the result value is 0. If the pidl is invalid (depth greater than MAX_PATH) the function returns -1.

Description

PidlGetLength returns the size in bytes of the item identifier list, excluding the zero terminator. Note that by definition the length of a pidl should equal IMalloc.GetSize(Pidl) - 2. This function does not rely on that and instead walks the entire list, summing the size of the individual item identifiers.

See Also

PidlGetDepth

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

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository