tlaGetNames
Copy All Function or API Macro Names to Clipboard

CodeWright® - API Macro - Royalty Free - 2005.01.01 17:15
Send Comments

Purpose

Copy All Function or API Macro Names to Clipboard.

Function Replaced

tlaGetNames is replaced by tlaNames that has more capabilities:

  • Does not rely on the Routines function.
  • Operates in CodeWright.
  • Operates in CodeWright for .NET.
  • Provides optional sotrting of the output.
  • Provides optional viewing of the output.

tlaNames is documented on this website and is included in tlaTools.

tlaGetNames is not included in tlaTools.

Operation

This function runs the Routines( ) function against the current buffer. It detects if the output from Routines( ) contains API macros or functions. It then scans for the macro or function name on each line of the Routines( ) output.

When one is found the macro or function name is copied to the clipboard. The result is that at completion the clipboard will contain the name of every macro or function that is defined in the buffer.

After executing this function, position to the location of your choice and paste the list of name using a Paste (ctrl-V) command.

A log is created and returned based on the paramater you select. If you select "Edit" it is returned as a new edit buffer. If you select "Output" it is returned in the Output window Search 1 pane. (Note that the "Output" option requires CodeWright 7.5.1 or higher.)

The log has the following format:

tlaGetNames: E:\Develop\CodeWright\tlaMDE.c - 7 Function(s)

private_Error
private_String
_init
tlaMDE
private_Error
private_Message
private_String

In addition, the clipboard will contain the extracted names (in this case the seven names listed between the two delimiters in the log).

Example

tlaGetNames( "edit" );
tlaGetNames( "output" );

Input Parameters

Parm Name Code Meaning
1 Output "edit" Emit output tp new edit buffer.
"output" Emit output to Output window Search 1 pane.

Return Codes

Code Message
-1 tlaGetNames: Edit buffer not selected - halted.
-1 tlaGetNames: Function not supported by CodeWright for .NET.
-1 tlaGetNames: No names copied to clipboard from filename
-1 tlaGetNames: Paramater not "Edit" or "Output".

Reference

This function calls tlaError.

Compatibility

Current version verified under:

  • CodeWright 7.0c
  • CodeWright 7.5.1
  • CodeWright 7.5.2
  • CodeWright for .NET 7.0 does not support this function

CodeWright for .NET Restriction

This function requires the Compact display capable in CodeWright that is not available in CodeWright for .NET.

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.

tlaGetNames is not included as a function in tlaTools.

tlaNames is included as a function in tlaTools.

Copyright © 1993-2005 Thom Little Associates, Ltd. revised 2005.01.01 17:15
One Central Square, Keene, NH 03431-3787 phone 603-357-7567