swirl
Guide to OmniMark 9   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax   Related Concepts  
operator  

is attached

 
 

Return type: Switch
Returns:       Returns true if the stream is attached to an object and false otherwise. Replacing is with isnt will reverse the results.

Syntax

stream-name (is | isnt) attached 


Purpose

A stream test used to determine whether a stream is attached to an object.

Usage Notes

A stream can have three states: unattached (initial state), opened or closed.

Streams may be attached to any one of five objects:

  1. Buffers
  2. Files
  3. Referents
  4. External string sink functions
  5. #markup-parser

The association between an object and the attached stream can be broken using discard. If the stream was attached to a buffer, discard destroys the buffer.

    Related Syntax
 
Related Concepts
 
 

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

OmniMark 9.0β Documentation Generated: September 16, 2008 at 1:41:41 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.