getipv4addr

2024/09/04 13:35 Macro::TTL コマンドリファレンス

【Tera Term マクロ言語】コマンドリファレンス

getipv4addr 機能

[その他のコマンド]

自端末のIPv4アドレスを取得します。

コマンドライン

getipv4addr <string array> <intvar>

機能説明

自端末のIPv4アドレスを取得して、配列型変数へ格納します。
配列型変数は、strdim で事前に宣言しておく必要があります。

<string array>

IPアドレスを格納する文字型配列です。

getipv4addr を実行する前に strdim で宣言した変数名を指定してください。
端末に設定している IP アドレスをすべて格納できるだけの余裕をもって宣言する必要があります。

<intvar>

IPアドレスの個数を格納する整数型変数です。
IPアドレスが存在しない場合、0が格納されます。

パラメータの説明

指定するパラメータは以下の通りです。

パラメータ	型	パラメータ説明
<string array>	文字列型配列	IPアドレスを格納する配列を指定します。
<intvar>	整数	IPアドレスの数を格納する変数を指定します。

対象バージョン

バージョン 4.78 以降で利用可能です。

戻り値

戻り値として以下の変数が定義されます。

変数名	値	意味
result	-1	IPアドレスの取得に失敗した
	0	IPアドレスの個数が <string array> の要素数より大きく、格納しきれなかった
	1	IPアドレスの取得に成功した
<intvar>	文字列	取得した IPv4 アドレスの数

<intvar> は、コマンド実行時に指定した任意の文字列です。

種別：その他	Ver	機能の簡易説明
getipv6addr	4.78以降	自端末のIPv6アドレスを取得する。
strdim	4.72以降	文字列配列型の変数を宣言する。

使用方法

使用例

・格納した IP アドレスをメッセージ表示する場合

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

サンプル

サンプルマクロはありません。

備考

特にありません。

Tera Term のススメ