File: func_world_sendlines.xhtml

package info (click to toggle)
kildclient 3.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster
  • size: 6,320 kB
  • sloc: ansic: 24,830; xml: 7,500; sh: 4,295; perl: 2,877; makefile: 172
file content (26 lines) | stat: -rw-r--r-- 4,119 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"><head><title>C.79. $world-&gt;sendlines</title><link rel="stylesheet" type="text/css" href="docbook.css"/><link rel="stylesheet" type="text/css" href="kildclient.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/><link rel="prev" href="func_world_sendfile.xhtml" title="C.78. $world-&gt;sendfile"/><link rel="next" href="func_world_sendmsdpcommand.xhtml" title="C.80.  $world-&gt;sendmsdpcommand"/></head><body><header><div class="navheader"><table style="width: 100%; "><tr><th style="text-align: center; " colspan="3">C.79. <code class="function">$world-&gt;sendlines</code></th></tr><tr><td style="width: 20%; text-align: left; "><a accesskey="p" href="func_world_sendfile.xhtml">Prev</a> </td><th style="width: 60%; text-align: center; ">Appendix C. $world Reference</th><td style="width: 20%; text-align: right; "> <a accesskey="n" href="func_world_sendmsdpcommand.xhtml">Next</a></td></tr></table><hr/></div></header><section class="sect1" id="func_world_sendlines"><div class="titlepage"><div><div><h2 class="title" style="clear: both">C.79. <code class="function">$world-&gt;sendlines</code></h2></div></div></div><div class="abstract"><div class="abstract-title">Abstract</div><p>$world-&gt;sendlines function: SENDs several LINES to the world</p></div><div class="funcsynopsis"><table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"><tr><td><code class="funcdef">$success = $world-&gt;sendlines(</code></td><td>
      <code>multi-line string</code>
    , </td></tr><tr><td> </td><td>
      [<code>delay</code>
    , </td></tr><tr><td> </td><td>
      [<code>n-lines</code>]]
    <code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"><tr><td><code class="funcdef">$success = $world-&gt;sendlines(</code></td><td>
      <code>[ line 1, line 2, ... ]</code>
    , </td></tr><tr><td> </td><td>
      [<code>delay</code>
    , </td></tr><tr><td> </td><td>
      [<code>n-lines</code>]]
    <code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Sends several lines of text to the world.
<em class="parameter"><code>delay</code></em> is the number of seconds to wait between
sending each group of lines, and <em class="parameter"><code>n-lines</code></em> is the
number of lines to send a time. If these values are not specified,
they are taken from the defauls set in the Preferences dialog (see
<a class="xref" href="sec_pref_sending.xhtml" title="5.2. Sending">Section 5.2, “Sending”</a>).</p><p>There are two ways to specify the lines to be sent: the first is
passing a multi-line string, which is split into lines and each line
is sent separately. The second one is passing a reference to an array
where each element consists of one line.</p><p>This function always returns true.</p><p>For more options, see the <a class="xref" href="func_world_mlsend.xhtml" title="C.64. $world-&gt;mlsend"><code class="function">$world-&gt;mlsend</code></a> function which allows adding a text
before and/or after each line, and sending lines before and/or after
sending the contents of the file.</p></section><footer><div class="navfooter"><hr/><table style="width: 100%; "><tr><td style="width: 40%; text-align: left; "><a accesskey="p" href="func_world_sendfile.xhtml">Prev</a> </td><td style="width: 20%; text-align: center; "><a accesskey="u" href="apc.xhtml">Up</a></td><td style="width: 40%; text-align: right; "> <a accesskey="n" href="func_world_sendmsdpcommand.xhtml">Next</a></td></tr><tr><td style="width: 40%; text-align: left; vertical-align: top; ">C.78. <code class="function">$world-&gt;sendfile</code> </td><td style="width: 20%; text-align: center; "><a accesskey="h" href="index.xhtml">Home</a></td><td style="width: 40%; text-align: right; vertical-align: top; "> C.80. 
  <code class="function">$world-&gt;sendmsdpcommand</code>
</td></tr></table></div></footer></body></html>