hiAddNonRepeatPrefix

hiAddNonRepeatPrefix(
t_prefix
)
=> t / nil

Description

Adds a string to the list of repeat filter strings. All strings is compared on every command run.

Any command that matches the prefix, for the number of characters of the prefix, does not get repeated by the hiRepeat command.

Arguments

t_prefix

The string prefix to be added to the list of repeat filter strings.

Values Returned

t	String prefix successfully added to the list of repeat filter strings.
nil	The t_prefix value is either empty or in an invalid format. A warning message is displayed in the CIW.

Examples

This section explains the use model of hiAddNonRepeatPrefix().

• If a prefix is added that is more generic than a prefix that already exists in the list, the new prefix is added and it supersedes the more specific filter.
  For example:

  hiAddNonRepeatPrefix( "println" )
  => t
  hiAddNonRepeatPrefix( "print" )
  => t

  As print filters more than println, that is, it is more generic, only print is used for filtering unless it is removed using hiRemoveNonRepeatPrefix(). However, println still exist in a superseded state, removing “print” would cause println to be used as a filter.
• The command returns nil, and does not add the prefix to the list of repeat filter strings if another prefix is added with this function, as it would cause the same item to be filtered again.
  For example:

  hiAddNonRepeatPrefix( "print" ) 
  => t
  hiAddNonRepeatPrefix( "println" ) 
  => nil

  The list contains print, but not println after the above commands are run.
• The prefix print would filter any command that begins with print, such as:
  

  println("Hello, world")

  or

  printf ( "x = %d\n" x )

  but would not filter commands that simply contain the word print, such as:

  printf ( MyStr “name = %s” MyName )

Related Topics

hiRepeat

hiGetNonRepeatPrefixes

hiRemoveNonRepeatPrefix

General Environmental Functions

Return to top