hmLNの基礎中の基礎のAPI

概要

hmLN自体が備えているAPIは数は多くありません。

ここではその中でも、「これだけは知っておくべき」というAPIだけを列挙しました。

これらの関数はhmPyと同じ名前の関数となります。

基本となる6つの関数

以下の6つのAPIを知るだけで、秀丸マクロとLuaの値のやりとりは十分できます。

  • 命令の実行:
     └ DoString(szexpression)

    文字列「szexpression」をLuaの命令として実行します。

    何らかの明確な内部エラーがあった場合は0が、とりあえず実行できた場合は1が返ってきます。


  • 命令の実行:
     └ DoFile(filename)

    ファイル名「filename」内の記述内容をLuaの命令として実行します。

    何らかの明確な内部エラーがあった場合は0が、とりあえず実行できた場合は1が返ってきます。


  • 値の取得(整数):
     └ GetNumVar(sz_var_name)

    Lua内のグローバル変数「sz_var_name」を「整数」として取得します。

    元々が数値でなくとも、数値に変換可能なものであれば、整数として返ってきます。
    該当の変数が存在しなかったり、エラーが発生した場合は、0が返ってきます。
    対象の値が元々0の場合と区別がつかないですが、運用でカバーしてください。


  • 値の設定(整数):
     └ SetNumVar(sz_var_name, value)

    Lua内のグローバル変数「sz_var_name」に整数「value」を設定(代入)します。

    該当の変数が存在しなかったり、エラーが発生した場合は、0が返ってきます。
    代入に成功した場合は、1が返ってきます。


  • 値の取得(文字列):
     └ GetStrVar(sz_var_name)

    Lua内のグローバル変数「sz_var_name」を「文字列」として取得します。

    元々が文字列でなくとも、文字列に変換可能なものであれば、文字列として返ってきます。
    該当の変数が存在しなかったり、エラーが発生した場合は、「""」が返ってきます。
    対象の文字列が元々「""」の場合と区別がつかないですが、運用でカバーしてください。


  • 値の設定(文字列):
     └ SetStrVar(sz_var_name, value)

    Lua内のグローバル変数「sz_var_name」に文字列「value」を設定(代入)します。

    該当の変数が存在しなかったり、エラーが発生した場合は、0が返ってきます。
    代入に成功した場合は、1が返ってきます。