JCL Help:SHGetItemInfoTip

 JCL Help: SHGetItemInfoTip Function

Windows_Specific.Shell.Miscellaneous

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 item's info tip.

Pascal

 function SHGetItemInfoTip(const Folder: IShellFolder; Item: PItemIdList): string;

Parameters

Parameters	Description
const Folder: IShellFolder	Parent folder of the Item
Item: PItemIdList	Item for which to retrieve the infotip

Return Value

The item's infotip or an empty string if the function fails.

Description

GetItemInfoTip returns the infotip (hint) associated with the specified item. Set Item to the item identifier for which you want to retrieve the infotip and set Folder to the parent of the supplied item. If the function fails or the specified item does not have an infotip the result is an empty string.

About

Unit

JclShell

Donator

Marcel van Brakel

Notes

The returned string may contain multiple carriage return linefeed (#13#10) combinations

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