Phantasmal Site > Phantasmal API > API Listing > new_help_directory

API Function: new_help_directory

Summary:

read and register directory of help files

Defined In LPC Object:

/usr/System/sys/helpd.c

Prototype:

void new_help_directory(string path)

Can Be Called By:

System, Common, Game

Description:

Read all files ending in .hlp as help entries, and make them available for querying. new_help_directory scans the directory given and all subdirectories. It also registers the directory for automatic upgrade on recompile, and rereading with the reread_help_files function.

Return Value:

Nothing.

Errors:

Errors can occur in reading files or parsing help entries.

See Also:

reread_help_files , new_help_file , clear_registered_help_dirs