Help

_HASPInformation, _SendSystemInfo, About, ClearLog, EnableLogging, HelpContents, HelpCursor, HelpFolder, HelpHotkeys, HelpOpenGitHub, HelpSearch, LogPerSession, OpenLogFile, OpenLogFolder, VersionUpdateAvailability

About

This function runs the Help > About menu command.

Description 

 About();

Displays the application logo together with the software and build version, Laboratory Imaging copyright and licence information.

ClearLog

This function runs the Help > Clear Log File menu command.

Description 

 ClearLog();

This function clears the already recorded log file.

EnableLogging

This function runs the Help > Enable Logging menu command.

Description 

 EnableLogging(
   int  EnableLogging
);

This functions turns logging of important application events ON/OFF.

Parameters

int EnableLogging

Log important events?

0

Do not log important events.

1

Log important events.

HelpContents

This function runs the Help > Contents menu command.

Description 

 HelpContents();

Opens the software User Manual.

See Also 
HelpCursor, HelpSearch

HelpCursor

This function runs the Help > Help On Cursor menu command.

Description 

 HelpCursor();

Displays a help cursor, which allows you to click on any item in the software and get the help information about it. For instance, by clicking the File > Open menu item you get help information about the Open command. You can also run this function and type a keyboard shortcut to get help information about the command assigned to this shortcut.

See Also 
HelpContents, HelpSearch

HelpFolder

This function runs the Help > Show Help Folder menu command.

Description 

 HelpFolder();

This function displays the folder containing program help files.

HelpHotkeys

This function runs the Help > Hotkeys menu command.

Description 

 HelpHotkeys();

This function displays the folder containing program help files.

HelpOpenGitHub

Description 

 HelpOpenGitHub();

This function opens the GitHub help page in your browser.

HelpSearch

This function runs the Help > Search menu command.

Description 

 HelpSearch();

Opens the Fulltext search panel enabling the user to find a topic in the help document. Start typing the word(s) and the related chapters are immediately listed below.

See Also 
HelpContents, HelpCursor

LogPerSession

This function runs the Help > Log Per Session menu command.

Description 

 LogPerSession(
   int  LogPerSession
);

This function controls how the application log file is created.

Parameters

int LogPerSession

Create a log file on each startup?

0

Always use the same log file.

1

Create a new log file on each application startup.

OpenLogFile

This function runs the Help > Open Log File menu command.

Description 

 OpenLogFile();

OpenLogFolder

This function runs the Help > Open Log Folder menu command.

Description 

 OpenLogFolder();

VersionUpdateAvailability

This function runs the Help > Check Version Update menu command.

Description 

 VersionUpdateAvailability();

Opens the Available upgrades web page in your web browser where you can check for software updates after entering your licence ID.

_HASPInformation

This function runs the Help > HASP Info menu command.

Description 

 _HASPInformation();

This function gets the HASP ID number and information about the application configuration.

_SendSystemInfo

This function runs the Help > Save System Info menu command.

Description 

 _SendSystemInfo();

This function sends information about various system settings. It displays a dialog to get information about lengthy run of any function or not launching the processing. All the informations are then zipped and attached to an email message, which is send to our support centre.