Purpose

Access Online Help for all Functions.

Operation

This function accesses the page on the www.tlaNET.net that describes a function in this library.

You can issue a tlaHelp function call and specify the function name to be located or posting the cursor to the function name and execute tlaHelp with no parameters.

If you select the word "index" using either method you will positioned to the library index.

Examples

tlaHelp( "tlaEventSaveBuffer" )
tlaHelp( "index" )
tlaHelp( )

Input Parameters

Return Codes

Reference

None.

Compatibility

Current version verified under:

• CodeWright 7.0b
• CodeWright 7.0c
• CodeWright 7.5.1
• CodeWright 7.5.2
• CodeWright for .NET 7.0

CodeWright for .NET Restriction

None.

Installation

There are three primary methods for installing this macro on your system. Method A uses the tlaMDE tool available for purchase from this website. Method B manipulates the macro repository directly. Method C uses the API Macro... tool provided in every copy of CodeWright (but not CodeWright for .NET).

Method A - tlaMDE - CodeWright or CodeWright for .NET

• Select the Code button on this page.
• When the second window opens, select all the text in the text box.
• Issue Ctl-C (copy).
• Create a new file in CodeWright or CodeWright for .NET.
• Issue Ctl-V (paste).
• Issue tlaMDE C (save and compile).

Method B - Copy to Repository - CodeWright or CodeWright for .NET

• Select the Code button on this page.
• When the second window opens, select all the text in the text box for a macro.
• Issue Ctl-C (copy).
• Load the macro repository "cwright.mac" from your CodeWright or CodeWright for .NET root:
• issue Ctl-End to go to the end of file.
• Issue Ctl-V (paste).
• Close the file and respond yes to the write request.

Method C - API Macro ... - CodeWright Only

• Select the Code button on this page.
• When the second window opens, select text from the text box for a macro:
  • Do not select the [API Macro ... header line.
  • Select all other lines in the macro.
• Issue Ctl-C (copy).
• Open the CodeWright Tools | API Macros... dialog.
• Press the New button.
• Select the Edit box.
• Issue Ctl-V (paste).
• Double-click on the function name in the header of the macro.
• Issue Ctl-C (copy).
• Select the Name box.
• Issue Ctl-V (paste).
• Delete the trailing blank from the name.
• Select the Save button.
• Select the Close button.
• Repeat this process for each macro in the text box.

Purchase

tlaTools is a Dynamic Link Library that contains most of the API macros on this website in a single easy to install package. The tlaTools DLL can be purchased by selecting the Buy button on this page.

tlaHelp is included as a function in tlaTools.