Programmer Guide/Command Reference/FIND - Revision history

Jw at 13:15, 5 April 2016

2016-04-05T13:15:25Z

← Older revision		Revision as of 15:15, 5 April 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found, in which case am appropriate return code <code>$RC</code> will be set, too). Note that the <code>FIND</code> command can only be used with [[Programmer_Guide/Concepts/Simple_table\|simple tables]], and with string and name fields of [[Programmer_Guide/Concepts/Extended_table\|extended tables]].		The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found, in which case an appropriate return code <code>$RC</code> will be set, too). Note that the <code>FIND</code> command can only be used with [[Programmer_Guide/Concepts/Simple_table\|simple tables]], and with string and name fields of [[Programmer_Guide/Concepts/Extended_table\|extended tables]].

	#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]		#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]

Jw: fixed taggedonly parameter

2015-04-14T05:35:02Z

fixed taggedonly parameter

← Older revision		Revision as of 07:35, 14 April 2015
Line 8:		Line 8:
	;<var>field</var>: for an [[Programmer_Guide/Concepts/Extended_table\|extended tables]], this has to be the zero-based index, or the name of, of the string field, or the name field, to be searched. For [[Programmer_Guide/Concepts/Simple_table\|simple tables]], this parameter is ignored (but has to be present!), and should be set to <code>*</code>.		;<var>field</var>: for an [[Programmer_Guide/Concepts/Extended_table\|extended tables]], this has to be the zero-based index, or the name of, of the string field, or the name field, to be searched. For [[Programmer_Guide/Concepts/Simple_table\|simple tables]], this parameter is ignored (but has to be present!), and should be set to <code>*</code>.
	;<var>mask</var>: the search mask (wildcards are possible)		;<var>mask</var>: the search mask (wildcards are possible)
	;<var>taggedonly</var>: if set to <code>1</code>, ~~only~~ ''~~tagged~~'' entries will be searched. If set to <code>1</code> ~~(which is the default)~~, ''~~all~~'' entries ~~of the table~~ will be searched.		;<var>taggedonly</var>: If set to <code>0</code> (default), ''all'' entries of the table will be searched. if set to <code>1</code>, only ''tagged'' entries will be searched.
	;<var>respectcase</var>: if set to <code>0</code>, the search will be case-insensitive ~~(this is the default)~~. If set to <code>1</code>, the search will case-sensitive.		;<var>respectcase</var>: if set to <code>0</code> (default), the search will be case-insensitive. If set to <code>1</code>, the search will case-sensitive.

	For more complex query operations, you should consider the <code>[[Programmer_Guide/Command_Reference/QUERY\|QUERY]]</code>, or even the <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FIND\|SET table FIND]]</code> command (q.v.). ''N.B.:'' It is important to not mix up these commands, since they work in different ways, and offer different options, and functionality.		For more complex query operations, you should consider the <code>[[Programmer_Guide/Command_Reference/QUERY\|QUERY]]</code>, or even the <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FIND\|SET table FIND]]</code> command (q.v.). ''N.B.:'' It is important to not mix up these commands, since they work in different ways, and offer different options, and functionality.

Christian at 15:41, 6 April 2011

2011-04-06T15:41:08Z

← Older revision		Revision as of 17:41, 6 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found). Note that the <code>FIND</code> command can only be used with [[Programmer_Guide/Concepts/Simple_table\|simple tables]], and with string and name fields of [[Programmer_Guide/Concepts/Extended_table\|extended tables]].		The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found, in which case am appropriate return code <code>$RC</code> will be set, too). Note that the <code>FIND</code> command can only be used with [[Programmer_Guide/Concepts/Simple_table\|simple tables]], and with string and name fields of [[Programmer_Guide/Concepts/Extended_table\|extended tables]].

	#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]		#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]

Christian at 14:55, 6 April 2011

2011-04-06T14:55:33Z

← Older revision		Revision as of 16:55, 6 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found). Note that the <code>FIND</code> command can only be used with simple tables, and with string and name fields of extended tables.		The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found). Note that the <code>FIND</code> command can only be used with [[Programmer_Guide/Concepts/Simple_table\|simple tables]], and with string and name fields of [[Programmer_Guide/Concepts/Extended_table\|extended tables]].

	#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]		#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]
Line 6:		Line 6:
	;<var>table</var>: the name of the table item to search		;<var>table</var>: the name of the table item to search
	;<var>entry</var>: the zero-based index of the item where the search should start, the asterisk, <code>*</code> (or, obviously, the index 0) indicating that the whole table is to be searched		;<var>entry</var>: the zero-based index of the item where the search should start, the asterisk, <code>*</code> (or, obviously, the index 0) indicating that the whole table is to be searched
	;<var>field</var>: for an extended ~~table~~, this has to be the zero-based index, or the name of, of the string field, or the name field, to be searched. For simple tables, this parameter is ignored (but has to be present!), and should be set to <code>*</code>.		;<var>field</var>: for an [[Programmer_Guide/Concepts/Extended_table\|extended tables]], this has to be the zero-based index, or the name of, of the string field, or the name field, to be searched. For [[Programmer_Guide/Concepts/Simple_table\|simple tables]], this parameter is ignored (but has to be present!), and should be set to <code>*</code>.
	;<var>mask</var>: the search mask (wildcards are possible)		;<var>mask</var>: the search mask (wildcards are possible)
	;<var>taggedonly</var>: if set to <code>1</code>, only ''tagged'' entries will be searched. If set to <code>1</code> (which is the default), ''all'' entries of the table will be searched.		;<var>taggedonly</var>: if set to <code>1</code>, only ''tagged'' entries will be searched. If set to <code>1</code> (which is the default), ''all'' entries of the table will be searched.

Christian at 14:52, 6 April 2011

2011-04-06T14:52:49Z

← Older revision		Revision as of 16:52, 6 April 2011
Line 27:		Line 27:
	delete /Var #t		delete /Var #t
	exit		exit

			''See also:'' <code>[[Programmer_Guide/Command_Reference/QUERY\|QUERY]]</code>, and <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FIND\|SET table FIND]]</code>

Christian at 14:43, 6 April 2011

2011-04-06T14:43:30Z

← Older revision		Revision as of 16:43, 6 April 2011
Line 11:		Line 11:
	;<var>respectcase</var>: if set to <code>0</code>, the search will be case-insensitive (this is the default). If set to <code>1</code>, the search will case-sensitive.		;<var>respectcase</var>: if set to <code>0</code>, the search will be case-insensitive (this is the default). If set to <code>1</code>, the search will case-sensitive.

	For more complex query operations, you should consider the <code>[[Programmer_Guide/Command_Reference/QUERY\|QUERY]], or even the <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FIND\|SET table FIND]]</code> command (q.v.). ''N.B.:'' It is important to not mix up these commands, since they work in different ways, and offer different options, and functionality.		For more complex query operations, you should consider the <code>[[Programmer_Guide/Command_Reference/QUERY\|QUERY]]</code>, or even the <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FIND\|SET table FIND]]</code> command (q.v.). ''N.B.:'' It is important to not mix up these commands, since they work in different ways, and offer different options, and functionality.

	[macro FindStringInTable]		[macro FindStringInTable]

Christian at 14:43, 6 April 2011

2011-04-06T14:43:10Z

← Older revision		Revision as of 16:43, 6 April 2011
Line 10:		Line 10:
	;<var>taggedonly</var>: if set to <code>1</code>, only ''tagged'' entries will be searched. If set to <code>1</code> (which is the default), ''all'' entries of the table will be searched.		;<var>taggedonly</var>: if set to <code>1</code>, only ''tagged'' entries will be searched. If set to <code>1</code> (which is the default), ''all'' entries of the table will be searched.
	;<var>respectcase</var>: if set to <code>0</code>, the search will be case-insensitive (this is the default). If set to <code>1</code>, the search will case-sensitive.		;<var>respectcase</var>: if set to <code>0</code>, the search will be case-insensitive (this is the default). If set to <code>1</code>, the search will case-sensitive.

			For more complex query operations, you should consider the <code>[[Programmer_Guide/Command_Reference/QUERY\|QUERY]], or even the <code>[[Programmer_Guide/Shell_Items/Table/SET_TABLE#FIND\|SET table FIND]]</code> command (q.v.). ''N.B.:'' It is important to not mix up these commands, since they work in different ways, and offer different options, and functionality.

	[macro FindStringInTable]		[macro FindStringInTable]
	#t := new table *		#t := new table *

Christian at 14:36, 6 April 2011

2011-04-06T14:36:42Z

← Older revision		Revision as of 16:36, 6 April 2011
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	==FIND==		The <code>FIND</code> command searches a table item for a particular entry and returns the zero-based index of this entry (if found), or the empty string (if unfound, eh, not found). Note that the <code>FIND</code> command can only be used with simple tables, and with string and name fields of extended tables.

	~~The~~ <~~code~~>~~FIND~~</~~code~~> ~~command searches a table item for a particular entry and returns this entry's index (if found). The FIND command can only be used with simple tables or the extended table string~~/~~name fields.~~		#pos := FIND <var>table entry field</var> [ <var>mask taggedonly respectcase</var> ]

	~~<code>#pos := FIND <var>table entry field</var> [<var>mask</var> <var>tag case</var>]</code>~~		;<var>table</var>: the name of the table item to search
			;<var>entry</var>: the zero-based index of the item where the search should start, the asterisk, <code>*</code> (or, obviously, the index 0) indicating that the whole table is to be searched
	~~-> #pos = 'entryindex' or empty if not found~~		;<var>field</var>: for an extended table, this has to be the zero-based index, or the name of, of the string field, or the name field, to be searched. For simple tables, this parameter is ignored (but has to be present!), and should be set to <code>*</code>.
			;<var>mask</var>: the search mask (wildcards are possible)
	;<var>table</var>		;<var>taggedonly</var>: if set to <code>1</code>, only ''tagged'' entries will be searched. If set to <code>1</code> (which is the default), ''all'' entries of the table will be searched.
			;<var>respectcase</var>: if set to <code>0</code>, the search will be case-insensitive (this is the default). If set to <code>1</code>, the search will case-sensitive.
	:~~The~~ name of the table item to search.		[macro FindStringInTable]
			#t := new table *
	;<var>entry</var>		$#t * 'The big red apple was very juicy'
			$#t * 'The blue waves were mesmerizing'
	:<code>*</code> ~~for all entries~~ or the index ~~from which~~ to ~~start searching.~~		$#t * 'The green man said - "You are coming with me"'
			$#t * 'The red dwarf star was a million miles away'
	;<var>field</var>		#searchStr := 'red'
			do forever
	:~~Index~~ or name of string/name field. ~~This~~ parameter is ignored ~~for simple tables~~ and should be set to <code>*</code>.		#i := find $#t '$#i' '' '$#searchStr*'
			if '$rc' != 0 break
	;<var>mask</var>		um 'The table entry $#i ($#t[$#i]) contains the word "$#searchStr"'
			end
	:~~The~~ search mask (wildcards are possible).		delete /Var #t
			exit
	;<var>~~tag~~</var>

	:~~Search all (~~<code>0</code>~~) or~~ tagged (<code>1</code>) ~~fields. The default is <code>0</code>~~.

	;<var>~~case~~</var>

	:~~Ignore (~~<code>0</code>) ~~or respect (~~<code>1</code>) case~~. The default is <code>0</code>~~.

	~~<pre>~~
	[macro FindStringInTable]
	#t := new table *
	$#t * 'The big red apple was very juicy'
	$#t * 'The blue waves were mesmerizing'
	$#t * 'The green man said - "You are coming with me"'
	$#t * 'The red dwarf star was a million miles away'
	#searchStr := 'red'
	do forever
	#i := find $#t '$#i' '' '$#searchStr*'
	if '$rc' != 0 break
	um 'The table entry $#i ($#t[$#i]) contains the word "$#searchStr"'
	end
	delete $#t
	exit
	~~</pre>~~

Admin: 1 revision: Initial import

2010-11-18T16:31:34Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==FIND==

The <code>FIND</code> command searches a table item for a particular entry and returns this entry's index (if found). The FIND command can only be used with simple tables or the extended table string/name fields.

<code>#pos := FIND <var>table entry field</var> [<var>mask</var> <var>tag case</var>]</code>

-> #pos = 'entryindex' or empty if not found

;<var>table</var>

:The name of the table item to search.

;<var>entry</var>

:<code>*</code> for all entries or the index from which to start searching.

;<var>field</var>

:Index or name of string/name field. This parameter is ignored for simple tables and should be set to <code>*</code>.

;<var>mask</var>

:The search mask (wildcards are possible).

;<var>tag</var>

:Search all (<code>0</code>) or tagged (<code>1</code>) fields. The default is <code>0</code>.

;<var>case</var>

:Ignore (<code>0</code>) or respect (<code>1</code>) case. The default is <code>0</code>.

<pre>
[macro FindStringInTable]
#t := new table *
$#t * 'The big red apple was very juicy'
$#t * 'The blue waves were mesmerizing'
$#t * 'The green man said - "You are coming with me"'
$#t * 'The red dwarf star was a million miles away'
#searchStr := 'red'
do forever
#i := find $#t '$#i' '*' '*$#searchStr*'
if '$rc' != 0 break
um 'The table entry $#i ($#t[$#i]) contains the word "$#searchStr"'
end
delete $#t
exit
</pre>