Welcome to the new DelphiDabbler Code Library Documentation.

This is a new site that's currently running on alpha code. There are going to be bugs. If you discover any, please report them on the site's issues page (GitHub account required). Thanks.

Warning: Many URLs are going to change. Refer to the README file to discover which library project's documentation has been completed.

TPJSpecialFolderEnum

Project: Shell Folders Unit.

Unit: PJShellFolders.

Applies to: ~>2.0

Windows defines integer identifiers to represent the shell’s special folders. TPJSpecialFolderEnum is a class that enumerates the values of all the special folder identifiers.

The key method is the Next method which returns a sequence of identifiers each time it called. The Init methods re-intialises the enumeration and the AtEnd methods returns true when all the identifiers have been returned. The number of identifiers in the enumeration are given by the Count method.

TPJSpecialFolderEnum implements the IPJSpecialFolderEnum interface.

An example of using TPJSpecialFolderEnum is provided.

Methods

Method Description
AtEnd Tests whether the end of the enumeration has been reached.
Count Returns the number of special folder identifiers in the enumeration.
Create Constructs and intialises a TPJSpecialFolderEnum object.
Init Reinitialises the enumeration.
Next Returns the next identifier in the enumeration.

Properties

TPJSpecialFolderEnum defines no properties.

Events

TPJSpecialFolderEnum defines no events.