$read - Revision history

Jay2k1: clarified that s switch scans for a whole word

2016-03-18T13:07:13Z

clarified that s switch scans for a whole word

← Older revision		Revision as of 13:07, 18 March 2016
Line 20:		Line 20:
	\| t \|\| If the ''t'' switch is specified then mIRC will treat the first line in the file as plain text, even if it is a numeric.		\| t \|\| If the ''t'' switch is specified then mIRC will treat the first line in the file as plain text, even if it is a numeric.
	\|-		\|-
	\| s \|\| Scans the ''filename'' for a line beginning with the ''string'' and returns the text following the match value.		\| s \|\| Scans the ''filename'' for a line beginning with a word specified in the ''string'' and returns the text following the match value.
	\|-		\|-
	\| w \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' can contain [[If-Then-Else#iswm\|wildcards]].		\| w \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' can contain [[If-Then-Else#iswm\|wildcards]].

Cail: See also: $lines

2012-05-22T20:39:29Z

Cail at 09:13, 2 July 2007

2007-07-02T09:13:02Z

← Older revision		Revision as of 09:13, 2 July 2007
Line 47:		Line 47:

	[[kick]] [[$chan]] [[$nick]] $read(Example.txt) ;Kicks a user with a random line from the text file.		[[kick]] [[$chan]] [[$nick]] $read(Example.txt) ;Kicks a user with a random line from the text file.
	== Also ~~See~~ ==		== See Also ==
	* [[$readn]] This returns the line number that $read just returned.		* [[$readn]] This returns the line number that $read just returned.
	* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.		* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.

Albie: changed regex link

2005-12-16T15:15:06Z

changed regex link

← Older revision		Revision as of 15:15, 16 December 2005
Line 24:		Line 24:
	\| w \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' can contain [[If-Then-Else#iswm\|wildcards]].		\| w \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' can contain [[If-Then-Else#iswm\|wildcards]].
	\|-		\|-
	\| r \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' is taken as a [[~~Regular_Expressions~~\|regular expression]].		\| r \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' is taken as a [[Regular_Expression\|regular expression]].
	\|-		\|-
	\| p \|\| If the ''p'' switch is specified, command <nowiki>\|</nowiki> separators are treated as such instead of as plain text.		\| p \|\| If the ''p'' switch is specified, command <nowiki>\|</nowiki> separators are treated as such instead of as plain text.

Zyberdog: htmltable -> wikitable

2005-12-10T20:02:48Z

htmltable -> wikitable

← Older revision		Revision as of 20:02, 10 December 2005
Line 13:		Line 13:
	Take good note of the ''t'' switch in the table below.		Take good note of the ''t'' switch in the table below.

	~~<table border~~=1>		{\| style="width:100%"
	~~<tr>~~		\| style="width:5%" \| '''''Switch''''' \|\| style="width:95%" \| '''''Meaning'''''
	~~<td>~~'''''n'''''~~</td>~~		\|-
	~~<td>If the~~ '''''n''''' switch is specified then the line read in will not be evaluated and will be treated as plain text.~~</td>~~		\| n \|\| If the ''n'' switch is specified then the line read in will not be evaluated and will be treated as plain text.
	~~</tr>~~		\|-
	~~<tr>~~		\| t \|\| If the ''t'' switch is specified then mIRC will treat the first line in the file as plain text, even if it is a numeric.
	~~<td>'''''~~t~~'''''</td>~~		\|-
	~~<td>~~If the ~~'''~~''t~~'''~~'' switch is specified then mIRC will treat the first line in the file as plain text, even if it is a numeric.~~</td>~~		\| s \|\| Scans the ''filename'' for a line beginning with the ''string'' and returns the text following the match value.
	~~</tr>~~		\|-
	~~<tr>~~		\| w \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' can contain [[If-Then-Else#iswm\|wildcards]].
	~~<td>'''''~~s~~'''''</td>~~		\|-
	~~<td>~~Scans the ''filename'' for a line beginning with the ''string'' and returns the text following the match value.~~</td>~~		\| r \|\| Scans the ''filename'' for a line matching ''string'', where ''string'' is taken as a [[Regular_Expressions\|regular expression]].
	~~</tr>~~		\|-
	~~<tr>~~		\| p \|\| If the ''p'' switch is specified, command <nowiki>\|</nowiki> separators are treated as such instead of as plain text.
	~~<td>'''''~~w~~'''''</td>~~		\|}
	~~<td>~~Scans the ''filename'' for a line matching ''string'', where ''string'' can contain wildcards.~~</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>'''''~~r~~'''''</td>~~
	~~<td>~~Scans the ''filename'' for a line matching ''string'', where ''string'' is taken as a [[Regular_Expressions\|regular expression]].~~</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>'''''~~p~~'''''</td>~~
	~~<td>~~If the ''p'' switch is specified, command \| separators are treated as such instead of as plain text.~~</td>~~
	~~</tr>~~
	~~</table>~~

	== Examples ==		== Examples ==

Microbe: fixed commenting syntax and added reference to loadbuf

2005-11-10T13:23:52Z

fixed commenting syntax and added reference to loadbuf

← Older revision		Revision as of 13:23, 10 November 2005
Line 51:		Line 51:
	The above is an example text file used in the following examples.		The above is an example text file used in the following examples.

	$read(''Example.txt'',''s'',''Ave'') ;Returns ''It'', all data that follows the first line starting with ''Ave''.		$read(''Example.txt'',''s'',''Ave'') ;Returns ''It'', all data that follows the first line starting with ''Ave''.
	$read(''Example.txt'',''w'',''*moo'') ;Returns ''Fish go moo'', note the lack of pending asterisks means moo has to be the last word.		$read(''Example.txt'',''w'',''*moo'') ;Returns ''Fish go moo'', note the lack of pending asterisks means moo has to be the last word.
	$read(''Example.txt'',''3'') ;Returns ''6'', This is the 3rd line in the file if you count line 1 as the linecount line because it is a number.		$read(''Example.txt'',''3'') ;Returns ''6'', This is the 3rd line in the file if you count line 1 as the linecount line because it is a number.
	$read(''Example.txt'',''t'',''3'') ;Returns ''Hash Help Dot Script'', This is the 3rd line in the file if you count line 1 plain text.		$read(''Example.txt'',''t'',''3'') ;Returns ''Hash Help Dot Script'', This is the 3rd line in the file if you count line 1 plain text.
	$read(''Example.txt'',''w'',''*moo'') ;Returns ''		$read(''Example.txt'',''w'',''*moo'') ;Returns ''

	[[kick]] [[$chan]] [[$nick]] $read(Example.txt) ;Kicks a user with a random line from the text file.		[[kick]] [[$chan]] [[$nick]] $read(Example.txt) ;Kicks a user with a random line from the text file.
Line 62:		Line 62:
	* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.		* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.
	* [[filter]] This can help with more complex needs when reading in content from files or windows.		* [[filter]] This can help with more complex needs when reading in content from files or windows.
			* [[loadbuf]] This is a much better alternative if you need to dump many lines of text to a dialog or to a custom window

	[[Category:File and Directory Identifiers]]		[[Category:File and Directory Identifiers]]

Zyberdog: added category

2005-10-13T22:12:08Z

added category

← Older revision		Revision as of 22:12, 13 October 2005
Line 62:		Line 62:
	* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.		* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.
	* [[filter]] This can help with more complex needs when reading in content from files or windows.		* [[filter]] This can help with more complex needs when reading in content from files or windows.

			[[Category:File and Directory Identifiers]]

Albie at 21:01, 13 October 2005

2005-10-13T21:01:59Z

New page

Returns a line of text from a text file.
$read(''filename'',[ntswrp],[''string''],[''N''])
The first parameter is the filename and the only required parameter.
If you omit all other parameters you will be returned with a random line from the file.

The second parameter is a set of options that determin the type of search you wish to use, for a full description see the table below.
if ''string'' is numerical and you do not use ''swr'' switch the line corresponding to the numerical value will be returned.

If the ''N'' parameter is given it starts to search the file from that line number.

'''Note:''' If the first line of your text file is a numerical value mIRC treats this number as the total number of lines in the text file, be careful not to accidently have your file cut short due to an unexpected numerical value.
If you specify N = 0, mIRC returns the value of the first line if it's a number.
Take good note of the ''t'' switch in the table below.

<table border=1>
<tr>
<td>'''''n'''''</td>
<td>If the '''''n''''' switch is specified then the line read in will not be evaluated and will be treated as plain text.</td>
</tr>
<tr>
<td>'''''t'''''</td>
<td>If the '''''t''''' switch is specified then mIRC will treat the first line in the file as plain text, even if it is a numeric.</td>
</tr>
<tr>
<td>'''''s'''''</td>
<td>Scans the ''filename'' for a line beginning with the ''string'' and returns the text following the match value.</td>
</tr>
<tr>
<td>'''''w'''''</td>
<td>Scans the ''filename'' for a line matching ''string'', where ''string'' can contain wildcards.</td>
</tr>
<tr>
<td>'''''r'''''</td>
<td>Scans the ''filename'' for a line matching ''string'', where ''string'' is taken as a [[Regular_Expressions|regular expression]].</td>
</tr>
<tr>
<td>'''''p'''''</td>
<td>If the ''p'' switch is specified, command | separators are treated as such instead of as plain text.</td>
</tr>
</table>

== Examples ==
'''''Example.txt:'''''
5
Ave It
Hash Help Dot Script
6
Cows dont go moo, Fish go moo!
Fish go moo
Yes they do
The above is an example text file used in the following examples.

$read(''Example.txt'',''s'',''Ave'') ;Returns ''It'', all data that follows the first line starting with ''Ave''.
$read(''Example.txt'',''w'',''*moo'') ;Returns ''Fish go moo'', note the lack of pending asterisks means moo has to be the last word.
$read(''Example.txt'',''3'') ;Returns ''6'', This is the 3rd line in the file if you count line 1 as the linecount line because it is a number.
$read(''Example.txt'',''t'',''3'') ;Returns ''Hash Help Dot Script'', This is the 3rd line in the file if you count line 1 plain text.
$read(''Example.txt'',''w'',''*moo'') ;Returns ''

[[kick]] [[$chan]] [[$nick]] $read(Example.txt) ;Kicks a user with a random line from the text file.
== Also See ==
* [[$readn]] This returns the line number that $read just returned.
* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.
* [[filter]] This can help with more complex needs when reading in content from files or windows.

← Older revision		Revision as of 20:39, 22 May 2012
Line 49:		Line 49:
	== See Also ==		== See Also ==
	* [[$readn]] This returns the line number that $read just returned.		* [[$readn]] This returns the line number that $read just returned.
			* [[$lines]] This returns the total number of lines in the given file.
	* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.		* [[play]] This is a much better alternative if you require to list the content of a whole file to a channel.
	* [[filter]] This can help with more complex needs when reading in content from files or windows.		* [[filter]] This can help with more complex needs when reading in content from files or windows.