swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax   Related Concepts  
action  

put

 
 

Syntax

put stream-name indexer? open-modifiers? 
   (& stream-name indexer? open-modifiers?)*
    string-expression


Purpose

An action that writes the specified string-expression to one or more streams.

The string expression is evaluated only as needed, depending on its content:

Only the following open-modifiers are permitted with put:

  1. A string expression containing the element content format modifiers.
  2. The binary open modifier.

The specified open-modifiers replace the one currently in force. If no open-modifiers are specified, the ones currently in force are used.

Before writing text to the specified stream items, the put action saves the old #current-output set, and creates a new #current-output set consisting of the specified stream items. When the writing is complete, the previous #current-output is restored. This causes #current-output sets to be nested within each other. This useful feature is important when the string expression contains a %c operator.

#current-output may be given as one of the stream-names. In this case, the text is written to the set of streams that are currently active, as well as the other ones specified.

You can only use put on an open stream.

    Related Syntax
   #current-output
   binary
   file
 
Related Concepts
   Output
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:33:48 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.