macro/command/getipv4addr.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
  "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <title>getipv4addr</title>
  <meta http-equiv="Content-Style-Type" content="text/css">
  <link rel="stylesheet" href="../../style.css" type="text/css">
</head>

<body>


<h1>getipv4addr</h1>

<p>
Retrieves local IPv4 address(es). <em>(version 4.78 or later)</em>
</p>

<pre class="macro-syntax">
getipv4addr &lt;string array&gt; &lt;intvar&gt;
</pre>

<h2>Parameters</h2>

<dl>
        <dt class="macro">String array &lt;string array&gt;</dt>
        <dd>IP addresses are stored in the string array.</dd>

        <dt class="macro">Integer variable &lt;intvar&gt;</dt>
        <dd>IP address counts. If the IP address is none, it is set to 0.</dd>
</dl>

<h2>Return Value</h2>

<dl>
        <dt class="macro">System variable &lt;result&gt;</dt>
        <dd>When the IP addresses are retrieved, it is set to 1.<br>
            When the IP address counts is bigger than the &lt;string array&gt; entries, it is set to 0.<br>
            When the IP address can not retrieve, it is set to -1.</dd>
</dl>

<h2>Example</h2>

<pre class="macro-example">
ipaddr_size = 10
strdim ipaddr ipaddr_size

getipv4addr ipaddr num
if result = -1 then
    messagebox 'Error' 'IPv4 address'
elseif result = 0 then
    N = ipaddr_size - 1
    for i 0 N
        messagebox ipaddr[i] "IPv4 address"
    next
    N = num - ipaddr_size
    sprintf2 str "And %d address(es)." N
    messagebox str "IPv4 address"
else
    N = num - 1
    for i 0 N
        messagebox ipaddr[i] "IPv4 address"
    next
endif

</pre>

<h2>See also</h2>
<ul>
  <li><a href="getipv6addr.html">getipv6addr</a></li>
</ul>

</body>
</html>