tlaWriteModifiedBuffer
Write Non-System Read-Write Buffers if Changed

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

Purpose

Write Non-System Read-Write Buffers if Changed.

Operation

This function writes buffers to disk if they have been previously modified.

The scope of this function can be set to either All buffers or just the Current buffer.

tlaWriteModifiedBuffer will only write a buffer if it is not a system buffer, not a read-only buffer, and is previously marked as modified.

Example

tlaWriteModifiedBuffer( )
tlaWriteModifiedBuffer( "all" )
tlaWriteModifiedBuffer( "cur" )

Input Parameters

Parm Name Code Meaning
1 Scope   Write current non-system previously modified read-write buffer.
"all" Write all non-system previously modified read-write buffers.
"cur" Write current non-system previously modified read-write buffer.

Return Codes

Code Message
number tlaWriteModifiedBuffer: number buffers written (non system, previously modified, read write).
-1 tlaWriteModifiedBuffer: No buffers loaded.
-1 tlaWriteModifiedBuffer: No buffers written (non system, previously modified, read write).
-1 tlaWriteModifiedBuffer: Paramater not null, "all", or "cur".

Reference

This function calls tlaDateTime, tlaError, and tlaEventPrepareToSave.

Compatibility

Current version verified under:

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

CodeWright for .NET Restriction

The automatic date/time updating is provided by the tlaEventPrepareToSave event handler. Event processing is not available in CodeWright for .NET and as such this function will not automatically update files in that environment. When running under CodeWright for .NET tlaEventPRepareToSave is called directly to invoke this capability. When event handling is added to codeWright for .NET this reqriction will be removed.

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.

tlaWriteModifiedBuffer 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