UTIL_SortStreamsByKey

function

Library: Utilities (OMUTIL legacy)
Include: omutil.xin

Declaration

define function UTIL_SortStreamsByKey
   modifiable stream stream-shelf

Argument definitions

stream-shelf: is an shelf of streams

Purpose

Use UTIL_SortStreamsByKey to sort a shelf of streams by their keys in ascending order.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omutil.xin"

stream-shelf must

have a key for every item (else OmniMark Error 6052)
not have items that are unattached, still open, or most recently attached with referents-allowed (else OmniMark Error 6059)
not have items that were most recently attached (opened) as files or external function OMXs (else OmniMark Error 6005)

Usage Notes

You may want to write a function to build your stream shelf from your existing data.

Example

  include "omutil.xin"
  process
     local stream my-stream variable initial {"foo" with key "a", 
                                              "bar" with key "c",
                                              "sna" with key "b",
                                              "try" with key ""}
     UTIL_SortStreamsByKey my-stream
     
     repeat over my-stream
       output "key " 
          || key of my-stream
          || "; item " 
          || my-stream
          || "%n"
     again

Related Topics

Other Library Functions