open_buffer

This function is always used in combination with the function put_buffer_in_document. These functions together save parts of a result document to a location on the file system while the saved part (as opposed to the put_in_document function) is also written to the result document.

The function open_buffer indicates the position in the model document from where the result text will be saved. The marker is placed in the result document where this function is called.

open_buffer ( marker_name )

The function yields a result type BOOL: TRUE if the marker is successfully placed, FALSE if it failed to set the marker or if the function is not supported (ITP/Workstation).

The function open_buffer has one parameter:

1. marker_name, type TEXT. The function places a marker with this name at the position in the model document where it is called. Be aware that markers are case sensitive.

This function can only be used in ITP/Server.

Warning

If creation of the document is delayed, it can cause a FATAL ERROR at a later time.

Note

The function open_buffer fails if the name of the buffer is invalid (empty).

Because an identifier text is used you can call this function repeatedly throughout a model document, and thus store several fragments of result text, as long as you use a unique marker_name each time.

If the function open_buffer is called more than once with the same value for the parameter only the last position of the marker will be saved.

Example:

BOOL ok := open_buffer( "example" )

The marker example is placed in the text where this line is in the model document. The success of this action is stored in 'ok'.