swirl Guide to OmniMark 6   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesOMX VariablesErrors
 
  Related Syntax     Other Library Functions  
function   UTIL_SortStreamsByKey   Available in:
Professional
Enterprise

Library: omutil - miscellaneous system utilities
Include: omutil.xin

Declaration

  define function UTIL_SortStreamsByKey
     modifiable stream stream-shelf
  where
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

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 Syntax
   UTIL_SortIntegersByValue
   UTIL_SortIntegersByKey
   UTIL_SortStreamsByValue
   UTIL_SortSwitchesByKey
 
  Other Library Functions
   UTIL_Env
   UTIL_ExpRand
   UTIL_GetEnv
   UTIL_GetMilliSecondTimer
   UTIL_GetProcessId
   UTIL_IsVersionCompatible
   UTIL_LibraryVersion
   UTIL_Rand
   UTIL_Sleep
   UTIL_SortIntegersByKey
   UTIL_SortIntegersByValue
   UTIL_SortStreamsByKey
   UTIL_SortStreamsByValue
   UTIL_SortSwitchesByKey
   UTIL_Srand
   UTIL_UniformRand
 
----  

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

OmniMark 6.5 Documentation Generated: December 23, 2002 at 6:25:46 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © OmniMark Technologies Corporation, 1988-2002.