swirl
Guide to OmniMark 7   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax     Other Library Functions  
function  

UTIL_SortSwitchesByKey

 
 

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

Declaration

  define function UTIL_SortSwitchesByKey
     modifiable switch switch-shelf

Argument definitions

switch-shelf
is a keyed shelf of switches


Purpose

Use UTIL_SortSwitchesByKey to sort a shelf of switches by their keys in ascending order.

Requirements

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

  include "omutil.xin"

switch-shelf must have a key for every switch (else OmniMark Error 6052)

Usage Notes

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

Example


  include "omutil.xin"
  process
     local switch my-switch variable initial {true with key "a",
                                              false with key "c",
                                              true with key "b"}
     UTIL_SortSwitchesByKey my-switch

     repeat over my-switch
       output "key "
          || key of my-switch
          || "; item "
       do when my-switch
          output "true"
       else
          output "false"
       done
       output "%n"
     again

    Related Syntax
   sort.sort-by-value
   sort.sort-by-key
   UTIL_SortStreamsByValue
   UTIL_SortStreamsByKey
 
  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 ] [ LEGACYLIBRARIES ] [ ERRORS ]

OmniMark 7.1.2 Documentation Generated: June 28, 2005 at 5:46:00 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © Stilo Corporation, 1988-2005.