ht_tools.dll

top秀丸エディタマクロマクロで使うDLL

目次

はじめに

秀丸エディタ/秀丸メールで使用するマクロ拡張用DLLです。 マクロで(簡単には)実現できない(事もない?)各種機能(?)を提供します。
(まぁ、大半は単なるWindows APIのラッパー(?)ですが・・・)

無保証です。

動作環境

秀丸エディタが必要です。秀丸メールでも動作します。 秀丸エディタはDLLをサポートしたVersion3.02以降、なるべく最新版を使用してください。 unicode版の関数を呼び出す(dllfuncw、dllfuncstrwを使用する)には、秀丸エディタVer.8以降が必要です。

以下の環境で動作確認しています。

nkf関連のコマンドを使用する場合はnkf32.dllが必要です。 nkd32.dllはVer.1系Ver.2.0.5以降 があります。

mecab関連のコマンドを使用する場合は、mecabのインストールが必要です。 MeCab: Yet Another Part-of-Speech and Morphological Analyzerから入手して下さい。

hunspell関連のコマンドを使用する場合は、libhunspell.dll と 辞書ファイルが必要です。

64bit版の場合、64bit版の、nkf、mecabが必要になります。(コンパイル済みのものは見たことありませんが。)
libhunspell.dllは、改造版に64bit版が含まれます。

page top

ファイルの説明

圧縮ファイル内に以下のファイルが格納されています。 (フォルダ構造を保ったまま展開してください。)

page top

インストール・アンインストール

インストール

アンストール

"ht_tools.dll"と添付の文書(ht_tools.html)を削除するだけです。 レジストリ等は使用していません。

page top

機能概要

以下の関数が実装されています。詳細は各関数の解説を参照。

Window関連

その他

ファイル名操作・ファイル関連

iniファイル関連

ファイル操作

文字列関連

nkf関連

hmjre関連

mecab関連

hunspell関連

EditorConfig関連

page top

関数の説明

Window関連

TopWindow

関数名
TopWindow
機 能
最前面に設定・解除
書 式
#num = dllfunc("TopWindow", #handle, #set, #active)
引 数
#handle
ウィンドウハンドル
#set

設定

1:最前面
0:最前面解除
#active

アクティブ設定

1:アクティブ状態にする
0:非アクティブ状態する
戻り値
成功で1、失敗で0を返します。

機能概要へ戻る

IsTopWindow

関数名
IsTopWindow
機 能
最前面ウィンドウのチェック
書 式
#num = dllfunc("IsTopWindow", #handle)
引 数
#handle
ウィンドウハンドル
戻り値
最前面ウィンドウなら1、そうでないなら0を返します。

機能概要へ戻る

BottomWindow

関数名
BottomWindow
機 能
最背面に移動
書 式
#num = dllfunc("BottomWindow", #handle, #active)
引 数
#handle
ウィンドウハンドル
#active

ウィンドウの状態

1:アクティブ状態にする
0:非アクティブ状態する
戻り値
成功なら1、失敗なら0を返します。

機能概要へ戻る

SearchWindow

関数名
SearchWindow
機 能
指定されたウィンドウクラス、キャプションをもつウィンドウを検索する。
書 式
#num = dllfunc("SearchWindow", $ClassName, $Caption, #Flag)
引 数
$ClassName
ウィンドウクラス名、"" or "*"を指定するとすべてのウィンドウが対象になる。
$Caption
ウィンドウに表示されているキャプション
#Flag

キャプション検索時のフラグ

ビット割り付け

bit 00  キャプションチェック有無。0:なし 1:あり
これ以降、bit 00が"1"でなければ無効
bit 01  0:完全一致 1:含まれる
bit 02  0:大文字小文字を認識 1:大文字小文字を無視

FEDC BA98 7654 3210
xxxx xxxx xxxx xxx0 : XXX0 :チェックしない
xxxx xxxx xxxx 0001 : XXX1 :一致
xxxx xxxx xxxx 0011 : XXX3 :含まれる
xxxx xxxx xxxx 0101 : XXX5 : 一致、大文字小文字無視
xxxx xxxx xxxx 0111 : XXX7 :含まれる、大文字小文字無視
戻り値

見つかった場合はウィンドウハンドル、見つからない場合は0を返します。 複数のウィンドウがある場合、NextWindowHandle関数で残りのウィンドウハンドル を取得することができます。

手順としては、

  1. SearchWindow で検索
  2. NextWindowHandle で検索結果取得

となります。 "GetSearchWindowCount"は検索で見つけたハンドル数を、 "GetWindowCount"は"NextWindowHandle"で取得できるハンドル数を返します。

注意
検索フラグで最下位ビットが"0"の場合はキャプションを無視します。 検索対象となるウィンドウは表示されているトップレベルウィンドウのみです。

機能概要へ戻る

NextWindowHandle

関数名
NextWindowHandle
機 能
SearchWindow関数で検索されたウィンドウハンドルをかえします。
書 式
#num = dllfunc("NextWindowHandle")
引 数
なし
戻り値
複数のウィンドウが検索された場合はウィンドウハンドルを、 検索された全てのウィンドウハンドルを取り出した場合は0を返します。
注意
SearchWindow関数が実行されていない場合は常に0を返します。

機能概要へ戻る

GetSearchWindowCount

関数名
GetSearchWindowCount
機 能
SearchWindowで検索したウィンドウハンドルの数を返します。
書 式
#num = dllfunc("GetSearchWindowCount")
引 数
なし
戻り値
検索したウィンドウハンドルの数。
注意
SearchWindow関数が実行されていない場合は常に0を返します。 戻り値はSearchWindow関数が実行された時の値です。

機能概要へ戻る

GetWindowCount

関数名
GetWindowCount
機 能
SearchWindowで検索したウィンドウハンドルで取り出していないハンドルの数を返します。
書 式
#num = dllfunc("GetWindowCount")
引 数
なし
戻り値
取り出していないハンドルの数。
注意
SearchWindow関数が実行されていない場合は常に0を返します。 戻り値はNextWindowHandle関数で取り出せるウィンドウハンドル数です。

機能概要へ戻る

ActiveWindow

関数名
ActiveWindow
機 能
指定されたWindowをアクティブにする
書 式
#num = dllfunc("ActiveWindow", #handle)
引 数
#handle
アクティブにするウィンドウハンドル
戻り値
成功なら1、失敗なら0を返します。

機能概要へ戻る

GetActiveWindowHandle

関数名
GetActiveWindowHandle
機 能
アクティブなウィンドウのハンドルを取得
書 式
#num = dllfunc("GetActiveWindowHandle")
引 数
なし
戻り値
ウィンドウハンドル。

機能概要へ戻る

GetWindowClass

関数名
GetWindowClass
機 能
指定されたウィンドウのクラス名を取得
書 式
$str = dllfuncstr("GetWindowClass", #Handle)
引 数
#handle
ウィンドウハンドル
戻り値
ウィンドウのクラス名

機能概要へ戻る

GetWindowCaption

関数名
GetWindowCaption
機 能
指定されたウィンドウのキャプションを取得する。
書 式
$str = dllfuncstr("GetWindowCaption", #handle)
引 数
#handle
ウィンドウハンドル
戻り値
成功した場合は取得した文字列、失敗した場合は""を返します。

機能概要へ戻る

GetWindowState

関数名
GetWindowState
機 能
指定されたウィンドウの表示状態を取得
書 式
#num = dllfunc("GetWindowState", #handle)
引 数
#handle
ウィンドウハンドル
戻り値

成功した場合

失敗した場合は-1を返します。

機能概要へ戻る

SetWindowState

関数名
SetWindowState
機 能
指定されたウィンドウの表示状態を取得
書 式
#num = dllfunc("SetWindowState", #handle, #state)
引 数
#handle
ウィンドウハンドル
#state
表示状態
  • 0:非表示
  • 1:通常表示
  • 2:最小化
  • 3:最大化
戻り値
成功なら1、失敗なら0を返します。

機能概要へ戻る

NextWindow

関数名
NextWindow
機 能
1つ下のWindowハンドルを返す
書 式
#num = dllfunc("NextWindow", #handle)
引 数
#handle
ウィンドウハンドル
戻り値
数字を返します。 成功なら1、失敗なら0を返します。

機能概要へ戻る

NextActiveWindow

関数名
NextActiveWindow
機 能
一つ下のWindowをアクティブにする
書 式
#num = dllfunc("NextActiveWindow", #handle)
引 数
#handle
アクティブにするウィンドウハンドル
戻り値
数字を返します。 成功なら1、失敗なら0を返します。

機能概要へ戻る

FINDWINDOW

関数名
FINDWINDOW
機 能
指定されたクラス名、キャプションを持つWindowの検索
書 式
#num = dllfunc("FINDWINDOW", #handle, $WindowClassName, $WindowCaption)
引 数
#handle
検索する対象のウィンドウハンドル。 ウィンドウハンドルが指定された場合、そのウィンドウの子ウィンドウを検索します。 0(ZERO)なら、デスクトップを対象。
$WindowClassName
検索するウィンドウのクラス名。(省略可能)
$WindowCaption
検索するウィンドウのキャプション。(省略可能)
戻り値
成功ならウィンドウハンドル、失敗なら0を返します。

機能概要へ戻る

GetAncestorWindow

関数名
GetAncestorWindow
機 能
指定されたウィンドウの、親ウィドウのウィンドウハンドルを取得する。
書 式
#num = dllfunc("GetAncestorWindow", #handle)
引 数
#handle
対象のウィンドウハンドル。
戻り値
成功ならウィンドウハンドル、失敗なら0を返します。

機能概要へ戻る

GetWindowRect_Top

関数名
GetWindowRect_Top
機 能
指定されたウィンドウの、スクリーン座標を返す。(Top)
書 式
#num = dllfunc("GetWindowRect_Top", #handle)
引 数
#handle
対象のウィンドウハンドル。
戻り値
成功ならウィンドのスクリーン座標(Top)を、失敗なら-1を返します。

機能概要へ戻る

GetWindowRect_Bottom

関数名
GetWindowRect_Bottom
機 能
指定されたウィンドウの、スクリーン座標を返す。(Top)
書 式
#num = dllfunc("GetWindowRect_Bottom", #handle)
引 数
#handle
対象のウィンドウハンドル。
戻り値
成功ならウィンドのスクリーン座標(Bottom)を、失敗なら-1を返します。

機能概要へ戻る

GetWindowRect_Left

関数名
GetWindowRect_Left
機 能
指定されたウィンドウの、スクリーン座標を返す。(Left)
書 式
#num = dllfunc("GetWindowRect_Left", #handle)
引 数
#handle
対象のウィンドウハンドル。
戻り値
成功ならウィンドのスクリーン座標(Left)を、失敗なら-1を返します。

機能概要へ戻る

GetWindowRect_Right

関数名
GetWindowRect_Right
機 能
指定されたウィンドウの、スクリーン座標を返す。(Right)
書 式
#num = dllfunc("GetWindowRect_Right", #handle)
引 数
#handle
対象のウィンドウハンドル。
戻り値
成功ならウィンドのスクリーン座標(Right)を、失敗なら-1を返します。

機能概要へ戻る

ScreenToClient_X

関数名
ScreenToClient_X
機 能
スクリーン座標から、指定されたウィンドウのクライアント座標に変換(X)
書 式
#num = dllfunc("ScreenToClient_X", #handle, #X, #Y)
引 数
#handle
座標変換したいクライアント領域をもつ、ウィンドウハンドル。
戻り値
成功なら指定したウィンドウのクライアント座標(X)を、失敗なら-1を返します。

機能概要へ戻る

ScreenToClient_Y

関数名
ScreenToClient_Y
機 能
スクリーン座標から、指定されたウィンドウのクライアント座標に変換(Y)
書 式
#num = dllfunc("ScreenToClient_Y", #handle, #X, #Y)
引 数
#handle
座標変換したいクライアント領域をもつ、ウィンドウハンドル。
戻り値
成功なら指定したウィンドウのクライアント座標(Y)を、失敗なら-1を返します。

機能概要へ戻る

MOVEWINDOW

関数名
MOVEWINDOW
機 能
指定されたウィンドウを、指定された位置とサイズに設定する。
書 式
#num = dllfunc("MOVEWINDOW", #handle, #X, #Y, #WIDTH, #HEIGHT)
引 数
#handle
対象となるウィンドウハンドル。
#X
ウィンドウのX座標
#Y
ウィンドウのY座標
#WIDTH
ウィンドウの幅
#HEIGHT
ウィンドウの高さ
戻り値
成功なら1、失敗なら0を返します。

機能概要へ戻る

その他

GetDllVersion

関数名
GetDllVersion
機 能
バージョン情報の取得
書 式
#num = dllfunc("GetDllVersion")
引 数
なし
戻り値
バージョン情報を数字で返します。 「Major.Minor.Revision」各項目は2桁の10進数なので、最低でも5桁の数字になります。 Version 1.02.05なら10205を返します。

機能概要へ戻る

GetDllVersionStr

関数名
GetDllVersionStr
機 能
バージョン情報の取得
書 式
$str = dllfuncstr("GetDllVersionStr")
引 数
なし
戻り値
バージョン情報を文字列で返します。 Version 1.02.05なら"1.02.05"を返します。

機能概要へ戻る

Wait

関数名
Wait
機 能
指定された時間停止する。
書 式
#num = dllfunc("Wait", #MilliSecond)
引 数
#MilliSecond
停止する時間。ミリ秒で指定。
戻り値
正常終了時は"0"を返します。 引数に不正な値が指定されると-1を返します。

機能概要へ戻る

URLExchange

関数名
URLExchange
機 能
URL向けにエンコードした文字列を返す。
書 式
$str = dllfuncstr("URLExchange", $Str, #num)
引 数
$Str
変換文字列
#num

設定フラグ

0:全てエンコードする
1:スペースのみエンコード
2:ブラウザと同じく"#"、"?" 以降はエンコードしない
4:メタ文字を削除しない
8:エンコードしない
16:%XX をデコードする
戻り値
変換した文字列
注意
エンコードとデコードもできるらしいが、どうもいまいち・・・。

機能概要へ戻る

UrlEncode

関数名
UrlEncode
機 能
URL向けにエンコードした文字列を返す。
書 式
$str = dllfuncstr("UrlEncode", $Str, #num)
引 数
$Str
変換文字列
#num

設定フラグ

0:漢字(SJIS)のみ
1:漢字(SJIS)と" "(空白)
2:漢字(SJIS)、" "(空白)、「<>"#%{}|^~[]`」を変換。
戻り値
変換した文字列
注意

URL全体を指定すると不必要な文字までエンコードしてしまうかもしれません。

デコードした文字をrun命令で他のプログラムの引数に使う場合は注意が必要です。
マクロのrun命令では "%d"、"%f"、"%b"が以下のように特殊な意味を持ちます。
 %f :フルパスのファイル名
 %d :フォルダ名
 %b :フォルダを除いたファイル名
 (UrlEncodeでは常に大文字で返すが、大文字でも同様です。)
漢字をデコードした場合、これらの文字が含まれる場合があります。
引数に使用する場合はこれらの文字が含まれていないかチェックし、含まれる場合は
"%%f"のように"%"を2重にする必要があります

機能概要へ戻る

UrlEncodeW

関数名
UrlEncodeW
機 能
文字列をUTF-8に変換しURL向けにエンコードした文字列を返す。
書 式
$str = dllfuncstrw("UrlEncodeW", $Str, #num)
引 数
$Str
変換文字列
#num

設定フラグ

0:数字(0〜9)、アルファベット(A〜Z、a〜z)、"-"、"."、"_" 、"~" 以外を変換
1:すべて変換
戻り値
変換した文字列
注意

URL全体を指定すると不必要な文字までエンコードしてしまうかもしれません。

デコードした文字をrun命令で他のプログラムの引数に使う場合は注意が必要です。
マクロのrun命令では "%d"、"%f"、"%b"が以下のように特殊な意味を持ちます。
 %f :フルパスのファイル名
 %d :フォルダ名
 %b :フォルダを除いたファイル名
 (UrlEncodeでは常に大文字で返すが、大文字でも同様です。)
漢字をデコードした場合、これらの文字が含まれる場合があります。
引数に使用する場合はこれらの文字が含まれていないかチェックし、含まれる場合は
"%%f"のように"%"を2重にする必要があります

機能概要へ戻る

UrlDecode

関数名
UrlDecode
機 能
URL向けにエンコードされた文字列をデコードする。
書 式
$str = dllfuncstr("UrlDecode", $Str)
引 数
$Str
変換文字列
戻り値
変換した文字列
注意

機能概要へ戻る

TimeFormat

関数名
TimeFormat
機 能
時刻を指定された書式で返す。SetTime関数で日時を指定されていなければ現在時刻を使用する。
書 式
$str = dllfuncstr("TimeFormat", $format)
引 数
$format
書式指定文字列
戻り値
書式に従って文字列化した時間
注意

書式に指定できる文字列はC言語の"strftime"と同じですが、多少拡張(?)してあります。 "%"の後に"#"があると、数字を返す場合は先頭の"0"を省略します。 もともと文字列を返す書式に"#"を追加しても無視します。 %k・・・の場合、"#"があると漢字表記になります。

%a
曜日の省略名(Sun・・・)
%A
曜日の正式名(Sunday・・・)
%b
月の省略名(Jan、・・・)
%B
月の正式名(January、・・・)
%c
ロケールに応じた日付と時間の表現
%d
10進数で表す月の日付 (01〜31)
%H
24時間表記の時間 (00〜23)
%h,%I
12時間表記の時間 (01〜12)
%j
10進数で表す年頭からの日数 (001〜366)
%m
10進数で表す月 (01〜12)
%M
10進数で表す分 (00〜59)
%p
現在のロケールの AM/PM
%S
10進数で表す秒 (00〜59)
%U
10進数で表す週の通し番号。日曜日を週の最初の日とする (00〜53)。
%w
10進数で表す曜日。日曜日を 0 とする (0〜6)。
%W
10進数で表す週の通し番号。月曜日を週の最初の日とする (00〜53)。
%x
現在のロケールの日付表示
%X
現在のロケールの時刻表示
%y
10進数で表す西暦の下 2 桁 (00〜99)
%Y
10進数で表す4桁の西暦
%z、%Z
時間帯の名前またはその省略名。時間帯がわからない場合には文字を入れない。
%%
パーセント記号
%ka
曜日の省略名(日、月、火、水、木、金、土)
%kA
曜日の正式名(日曜日、・・・、土曜日)
%kB
月の和名(睦月、・・・、師走)
%kd
漢数字で表す月の日付 (一〜三一) #があると(%#kd)漢字表記になります。 (一〜三十一)
%kH
漢数字で表す24時間表記の時間 (〇〜二三) #があると(%#kh)漢字表記になります。 (零〜二十三)
%kI
漢数字で表す12時間表記の時間 (一〜一二) #があると(%#ki)漢字表記になります。 (一〜十二)
%kh
漢数字で表す12時間表記の時間 (〇〜一一) #があると(%#kh)漢字表記になります。 (零〜十一)
%km
漢数字で表す月 (一〜一二) #があると(%#km)漢字表記になります。 (一〜十二)
%kM
漢数字で表す分 (〇〜五九) #があると(%#km)漢字表記になります。 (零〜五十九)
%kp
午前・午後
%kS
漢数字で表す秒 (〇〜五九) #があると(%#kS)漢字表記になります。 (零〜五十九)
%ky
漢数字で表す西暦の下 2 桁 (〇〇〜九九)
%kY
漢数字で表す4桁の西暦 #があると(%#kY)漢字表記になります。

漢数字漢字表記に関してはメモを参照。

機能概要へ戻る

SetTime

関数名
SetTime
機 能
TimeFormatで変換する日時をセットする。
書 式
#num = dllfunc("SetTime", #year, #month, #day #hour, #min, #sec)
引 数
#year
4桁の西暦
#month
#day
#hour
24時間制の時刻(0〜23)
#min
分(0〜59)
#sec
秒(0〜59)
戻り値
常に"1"を返します。
注意
一度設定するとResetTimeを実行するまで解除されません。

機能概要へ戻る

ResetTime

関数名
ResetTime
機 能
TimeFormatで変換する日時をリセットする。
書 式
#num = dllfunc("ResetTime")
引 数
なし
戻り値
常に"1"を返します。
注意

機能概要へ戻る

NumStringToKanji

関数名
NumStringToKanji
機 能
数字(文字列)を漢数字または漢字表記に変換します。
書 式
$str = dllfuncstr("NumStringToKanji",$Numstr,#flag)
引 数
$Numstr
変換対象文字列
#flag

変換用フラグ

0:漢数字
1:漢字表記
戻り値
変換した文字列を返します。異常時は""を返します。
注意
数字のみで構成された文字列しか受け付けません。 負の値や、小数点があると""を返します。

機能概要へ戻る

NumToKanji

関数名
NumToKanji
機 能
数字を漢数字または漢字表記に変換します。
書 式
$str = dllfuncstr("NumToKanji",#Num,#flag)
引 数
#Num
変換対象数列
#flag

変換用フラグ

0:漢数字
1:漢字表記
戻り値
変換した文字列を返します。異常時は""を返します。
注意
負の値や、小数点があると""を返します。

機能概要へ戻る

GetStdout

関数名
GetStdout
機 能
コンソールプログラムを実行し、標準出力と標準エラー出力を取り込みます。
書 式
$str = dllfuncstr("GetStdout",$Cmdline, $Stdin)
引 数
$Cmdline
実行するファイルと起動オプションを指定する。
$Stdin
プログラムに送る文字列。
戻り値
実行ファイルが出力した文字列。
注意
標準入力を使う場合は注意してください。 送るデータがおかしいと、入力待ちになりそのまま制御を返さない場合もあります。

機能概要へ戻る

GetExitCode

関数名
GetExitCode
機 能
GetStdout関数で実行したファイルのリターンコードを取得する。
書 式
#num = dllfunc("GetExitCode")
引 数
戻り値
実行ファイルが返したリターンコード GetStdout関数を実行していない場合は"-1"が返ります。
注意

機能概要へ戻る

OpenHtmlHelp

関数名
OpenHtmlHelp
機 能
htmlhelp(*.chm)を開き、キーワードが指定されていれば検索し表示する。
書 式
#num = dllfunc("OpenHtmlHelp",$helpfile, $keyword)
引 数
$helpfile
開くヘルプファイルのフルパス
$keyword
検索する文字列
戻り値
検索に成功すると1、失敗すると0 を返します。
注意
$keyword に"" を指定すると単純にヘルプファイルを起動するだけです。

機能概要へ戻る

RUNSYNC

関数名
RUNSYNC
機 能
指定したプログラムを任意の状態で実行し、リターンコードを取得する。
書 式
#num = dllfunc("RUNSYNC",$program, #Error_code, #WindowMode)
引 数
$program
実行するプログラム名と引数。
#Error_code
関数が失敗した場合に返すコード。 実行するプログラムの戻り値と一致しない数字を指定して下さい。
#WindowMode

プログラム実行時の状態。以下の値が使用可能。

#SW_HIDE = 0
 ウィンドウを非表示にし、別のウィンドウをアクティブにする。
#SW_NORMAL = 1
 ウィンドウをアクティブにして表示。
#SW_SHOWMINIMIZED = 2
 ウィンドウをアクティブにし、最小化ウィンドウとして表示。
#SW_SHOWMAXIMIZED = 3
 ウィンドウをアクティブにし、最大化ウィンドウとして表示。
#SW_SHOWNOACTIVATE = 4
 ウィンドウを最新のサイズと位置で表示。
 アクティブなウィンドウは切り替わらない。
#SW_SHOW = 5
 ウィンドウをアクティブにし、現在のサイズと位置で表示。
#SW_MINIMIZE = 6
 指定したウィンドウを最小化し、Z オーダー上で次に上位となるウィンドウをアクティブにする。
#SW_SHOWMINNOACTIVE = 7
 ウィンドウを最小化ウィンドウとして表示。アクティブなウィンドウは切り替わらない。
#SW_SHOWNA = 8
 ウィンドウを現在の状態で表示。アクティブなウィンドウは切り替わらない。
#SW_RESTORE = 9
 ウィンドウをアクティブにして表示。
#SW_SHOWDEFAULT = 10
 アプリケーションを起動したプログラムの状態に基づいて、表示状態を設定。

通常使うのは0〜4まで。

戻り値
関数の実行に失敗すると"#Error_code"を、成功した場合はプログラムの戻り値となる。
注意
プラグラムが終了するまで待機します。

機能概要へ戻る

SendKeyPress

関数名
SendKeyPress
機 能
キーストロークをアプリケーションに送る。
書 式
#num = dllfunc("SendKeyPress",#vkey, #flag)
引 数
#vkey
操作したいキーの仮想キーコード(VK_??)
#flag

Shift、Ctrl、Altキーの状態設定 以下のビットの組み合わせを指定します。

0bit:Shift
1bit:Ctrl
2bit:Alt
戻り値
検索に成功すると1、失敗すると0 を返します。
注意
マクロ実行すぐにキーストロークを送信した場合、マクロ起動時のキーも 秀丸側に検出される場合があります。 マクロの起動を「Ctrl+A」で「Alt+B」を送ると「Ctrl+ALT+B」が認識されます。

機能概要へ戻る

GetClipboardOwnerHandle

関数名
GetClipboardOwnerHandle
機 能
現在クリップボードを所有しているウィンドウのハンドルを取得する。
書 式
#num = dllfunc("GetClipboardOwnerHandle")
引 数
なし
戻り値
現在クリップボードを所有しているウィンドウのハンドル。 失敗すると0 を返します。
注意

機能概要へ戻る

GetClipboardDSPTEXT

関数名
GetClipboardDSPTEXT
機 能
現在クリップボードから"CF_DSPTEXT"形式のデータを取り出す。
書 式
$str = dllfuncstr("GetClipboardDSPTEXT")
引 数
なし
戻り値
現在クリップボードにある、"CF_DSPTEXT"形式のデータ。 失敗すると"" を返します。
注意
秀丸エディタで、箱形(矩形)選択をした場合、"BOX"という文字がセットされます。

機能概要へ戻る

ファイル名操作・ファイル関連

GetChangeFileExt

関数名
GetChangeFileExt
機 能
拡張子を変更したファイル名を返す。
書 式
$str = dllfuncstr("GetChangeFileExt", $filename, $ext)
引 数
$filename
ファイル名
$ext
変更する拡張子
戻り値
文字列を返します。 成功した場合はファイル名の拡張子を変更した文字列を、 失敗した場合は""を返します。
注意
ファイル名に拡張子がない場合は拡張子が追加されます。

機能概要へ戻る

GetFileName

関数名
GetFileName
機 能
ファイルパスからファイル名を返す。
書 式
$str = dllfuncstr("GetFileName", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意

基本的に最期の"\"または":"以降を返します。

ただし"C:\TEMP\"と指定した場合は"TEMP\"を返します。

機能概要へ戻る

GetParentFolder

関数名
GetParentFolder
機 能
ファイルパスからフォルダ名を返す。
書 式
$str = dllfuncstr("GetParentFolder", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意
基本的に最期の"\"より前の文字を返します。

機能概要へ戻る

IsMatchFileName

関数名
IsMatchFileName
機 能
ファイル名がワイルドカードとマッチするか。
書 式
#num = dllfunc("IsMatchFileName", $filename, $wildcard)
引 数
$filename
対象のファイル名
$wildcard
ワイルドカード
戻り値
数字を返します。 マッチするなら"1"、しないなら"0"を返す。

機能概要へ戻る

GetFileExtention

関数名
GetFileExtention
機 能
ファイルパスから拡張子を返す。
書 式
$str = dllfuncstr("GetFileExtention", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意
基本的に最期の"."から後の文字を返します。 "."が必ず付きます。C:\TEMP\TEST.TXT" -> ".TXT"

機能概要へ戻る

GetFileBaseName

関数名
GetFileBaseName
機 能
ファイルパスからファイル名(拡張子なし)を返す。
書 式
$str = dllfuncstr("GetFileBaseName", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意
C:\TEMP\TEST.TXT" -> "TEST" を返す。

機能概要へ戻る

GetShortName

関数名
GetShortName
機 能
ファイルパスを短い形式にして返す。
書 式
$str = dllfuncstr("GetShortName", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意
存在しないファイル名を指定した場合は""を返します。

機能概要へ戻る

GetLongName

関数名
GetLongName
機 能
ファイルパスを長い形式にして返す。
書 式
$str = dllfuncstr("GetLongName", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意
存在しないファイル名、途中に存在しないフォルダを指定した場合は""を返します。 ネットワークパスを使用したファイルの変換はできません。

機能概要へ戻る

GetSpecialFolder

関数名
GetSpecialFolder
機 能
特殊なフォルダーの位置を返す。
書 式
$str = dllfuncstr("GetSpecialFolder", #num)
引 数
#num

フラグ

0:デスクトップ
1:お気に入り、
2:マイドキュメント、
3:アプリケーションデータ
戻り値
文字列を返します。
注意

機能概要へ戻る

GetExpandPath

関数名
GetExpandPath
機 能
相対指定のパスを展開する。
書 式
$str = dllfuncstr("GetExpandPath", $filename)
引 数
$filename
ファイル名
戻り値
文字列を返します。
注意

機能概要へ戻る

GetFileNameFromHwnd

関数名
GetFileNameFromHwnd
機 能
指定されたウィンドウハンドルから実行ファイル名を取得する。
書 式
$str = dllfuncstr("GetFileNameFromHwnd", #Hwnd)
引 数
#Hwnd
ウィンドウハンドル
戻り値
成功すれば、実行ファイル名を返します。
注意

機能概要へ戻る

GetCompactPath

関数名
GetCompactPath
機 能
ファイル名を指定された文字数内に収まるように省略して返す。
書 式
$str = dllfuncstr("GetCompactPath", $filename, #length)
引 数
$filename
ファイル名
#length
文字数
戻り値
成功すれば、省略されたファイル名を返します。
注意

機能概要へ戻る

GetFileSizeByte

関数名
GetFileSizeByte
機 能
指定されたファイルのサイズを返す。
書 式
#num = dllfunc("GetFileSizeByte", $filename)
引 数
$filename
ファイル名
戻り値
ファイルサイズをバイトで返します。
注意

失敗すると-1を返します。

プログラム的には64ビットまで対応していますが、マクロが符号付4バイト(32ビット) までなのであまり大きいサイズのファイルを指定するとどうなるかわかりません。 ファイルサイズが大きくなる場合は"GetFileSizeStr"を使ってください。 (ほぼ問題ないと思いますが。)

機能概要へ戻る

GetFileSizeStr

関数名
GetFileSizeStr
機 能
指定されたファイルのサイズを文字列で返す。
書 式
$str = dllfuncstr("GetFileSizeStr", $filename)
引 数
$filename

ファイル名

省略も可能。 省略した場合、直前に実行した以下の関数の結果を返す。

"GetFileSizeByte"
"GetUnitStr"
"GetSizeStr"
戻り値

ファイルサイズを文字列で返します。 ファイルサイズに合わせた単位で返します。

例)
     512 -> 512 bytes
    1024 -> 1.0 KB
 2500000 -> 2.5 MB
注意
失敗すると""を返します。 他のファイルサイズ取得関数を未実行時にファイル名を省略した場合は""を返します。 小数点以下は第一位で固定。"%5.1f"または"%5d"の書式で出力します。

機能概要へ戻る

GetUnitStr

関数名
GetUnitStr
機 能
指定されたファイルのサイズ単位を返す。
書 式
$str = dllfuncstr("GetUnitStr", $filename)
引 数
$filename

ファイル名

省略も可能。 省略した場合、直前に実行した以下の関数の結果を返す。

"GetFileSizeByte"
"GetUnitStr"
"GetSizeStr"
戻り値

ファイルサイズに合わせた単位を返します。

例)
     512 -> bytes
    1024 -> KB
 2500000 -> MB
注意
失敗すると""を返します。 他のファイルサイズ取得関数を未実行時にファイル名を省略した場合は""を返します。

機能概要へ戻る

GetSizeStr

関数名
GetSizeStr
機 能
指定されたファイルのサイズを文字列で返す。
書 式
$str = dllfuncstr("GetSizeStr", $filename)
引 数
$filename

ファイル名

省略も可能。 省略した場合、直前に実行した以下の関数の結果を返す。

"GetFileSizeByte"
"GetFileSizeStr"
"GetUnitStr"
戻り値

ファイルサイズを返します。

例)
     512 -> 512
    1024 -> 1.0
 2500000 -> 2.5
注意
失敗すると""を返します。 他のファイルサイズ取得関数を未実行時にファイル名を省略した場合は""を返します。

機能概要へ戻る

IsDirectory

関数名
IsDirectory
機 能
ディレクトリかどうか調べる
書 式
#num = dllfunc("IsDirectory", $filename)
引 数
$filename
調べたいファイル名
戻り値
0:ディレクトリではない。 1:ディレクトリである。
注意

機能概要へ戻る

GetFileAttr

関数名
GetFileAttr
機 能
ファイルの属性を取得
書 式
#num = dllfunc("GetFileAttr", $filename)
引 数
$filename
調べたいファイル名
戻り値
失敗した場合は-1、成功した場合は各属性がORされた値。Windows APIの戻り値そのまま。
#FILE_ATTR_ARCHIVE = 0x020
アーカイブファイル
#FILE_ATTR_COMPRESSED = 0x800
圧縮されているファイル・ディレクトリ
#FILE_ATTR_DIRECTORY = 0x010
ディレクトリ
#File_ATTR_HIDEN = 0x002
隠し属性
#FILE_ATTR_NORMAL = 0x080
特に属性なし
#FILE_ATTR_READONLY = 0x001
リードオンリー
#FILE_ATTR_SYSTEM = 0x004
システム属性
#FILE_ATTR_TEMPORARY = 0x100
テンポラリファイル
注意

機能概要へ戻る

IsFile

関数名
IsFile
機 能
ファイルかどうか調べる
書 式
#num = dllfunc("IsFile", $filename)
引 数
$filename
調べたいファイル名
戻り値
0:ファイルではない。 1:ファイルである。
注意

機能概要へ戻る

IsRelativePath

関数名
IsRelativePath
機 能
相対パスかどうか調べる
書 式
#num = dllfunc("IsRelativePath", $filename)
引 数
$filename
調べたいファイル名
戻り値
0:相対ファイル名ではない。 1:相対ファイル名である。
注意

機能概要へ戻る

GetRelativePathTo

関数名
GetRelativePathTo
機 能
相対パスを作成する。
書 式
$str = dllfuncstr("GetRelativePathTo", $basename, $filename)
引 数
$basename
基準にするファイル・フォルダ
$filename
相対パスにする対象
戻り値
$basenameを基準にした相対ファイル名
注意

機能概要へ戻る

IsUTF16LE

関数名
IsUTF16LE
機 能
指定されたファイルがUTF-16LEかチェックする。(BOMの確認のみ)
書 式
#num = dllfuncw("IsUTF16LE", $filename)
引 数
$filename
チェックするファイル
戻り値
UTF-16LEなら 1 を、違うなら 0 を返す。
注意
ファイルの先頭にある、BOMを確認しているだけです。ファイルの内容から判断している訳ではありません。

機能概要へ戻る

iniファイル関連

ReadSectionKeys

関数名
ReadSectionKeys
機 能
指定されたiniファイル(iniファイル形式のファイル)からセクションの全データを読み込む
書 式
#num = dllfunc("ReadSectionKeys", $filename, $section)
引 数
$filename
設定を読み込むファイル名
$section
読み込むセクション名
戻り値
0以上
読み込んだキーの数
-1
関数の実行に失敗
  • 引数のエラー
  • メモリ確保に失敗
注意
全データをメモリに読み込むのでリアルタイムに変更されると値が一致しない場合があります。 32kまで読み込み可能。

機能概要へ戻る

ExistKey

関数名
ExistKey
機 能
ReadSectionKeysで読み込んだデータに指定されたキーが存在するかどうかを返す。
書 式
#num = dllfunc("ExistKey", $key)
引 数
$key
チェックしたいキー
戻り値

0以上ならキーは存在し、その位置を示す。(0(zero)ベースの配列に格納されている)

-1:存在していない。  -2:ReadSectionKeysが実行されていない。

注意
値を取得するにはGetKeyValue関数を使います。

機能概要へ戻る

GetKeyValue

関数名
GetKeyValue
機 能
ReadSectionKeysで読み込んだデータから指定されたキーの値を返す。
書 式
$str = dllfuncstr("GetKeyValue", #num)
引 数
#num
取得するキーの位置。基本的にはExistKey関数の戻り値を使う。
戻り値
キーの値。存在していない位置を指定した場合は""を返す。
注意

機能概要へ戻る

GetIniKeyData

関数名
GetIniKeyData
機 能
ReadSectionKeysで読み込んだデータから"key=Value"という形式でデータを取り出す。
書 式
$str = dllfuncstr("GetIniKeyData")
引 数
戻り値
"key=Value"という形式のデータ
注意
取得するデータ位置をずらすにはNextKey関数を使います。

機能概要へ戻る

GetIniKey

関数名
GetIniKey
機 能
ReadSectionKeysで読み込んだデータからキーを取り出す。
書 式
$str = dllfuncstr("GetIniKey")
引 数
なし
戻り値
セクションに含まれるキー
注意
取得するデータ位置をずらすにはNextKey関数を使います。

機能概要へ戻る

GetIniKeyValue

関数名
GetIniKeyValue
機 能
ReadSectionKeysで読み込んだデータから値を取り出す。
書 式
$str = dllfuncstr("GetIniKeyValue")
引 数
なし
戻り値
セクションに含まれる値
注意
取得するデータ位置をずらすにはNextKey関数を使います。

機能概要へ戻る

NextKey

関数名
NextKey
機 能
GetIniKeyData、GetIniKey、GetIniKeyValueで取得するキー位置を+1する。
書 式
#num = dllfunc("NextKey")
引 数
なし
戻り値
1:取得データあり 0:取得データなし
注意

機能概要へ戻る

ReadSectionNames

関数名
ReadSectionNames
機 能
指定されたiniファイル(iniファイル形式のファイル)から、全セクション名を取得
書 式
#num = dllfunc("ReadSectionNames", $filename)
引 数
$filename
設定を読み込むファイル名
戻り値
取得したセクション数。関数が失敗した場合は-1。
注意

機能概要へ戻る

ExistSection

関数名
ExistSection
機 能
ReadSectionNamesで読み込んだデータに、指定されたセクションが存在するかどうかを返す。
書 式
#num = dllfunc("ExistSection", $section)
引 数
$section
チェックしたいセクション名
戻り値

0以上なら存在し、その位置を示す。(0(zero)ベースの配列に格納されている)

-1:存在していない。  -2:ReadSectionNamesが実行されていない。

注意
値を取得するにはGetSectionName関数を使います。

機能概要へ戻る

GetSectionName

関数名
GetSectionName
機 能
GetSectionNameで読み込んだデータから、指定されたセクション名を返す。
書 式
$str = dllfuncstr("GetSectionName", #num)
引 数
#num
取得するキーの位置。基本的にはExistSection関数の戻り値を使う。
戻り値
セクション名。存在していない位置を指定した場合は""を返す。
注意

機能概要へ戻る

GetSection

関数名
GetSection
機 能
ReadSectionNamesで読み込んだデータから、セクション名を返す。
書 式
$str = dllfuncstr("GetSection")
引 数
なし
戻り値
セクション名
注意
取得するデータ位置を変更するにはNextSection関数を使います。

機能概要へ戻る

NextSection

関数名
NextSection
機 能
GetSectionで取得する位置を変更(+1)する。
書 式
#num = dllfunc("NextSection")
引 数
なし
戻り値
1:取得データあり 0:取得データなし
注意

機能概要へ戻る

iniファイル関連(unicode版)

ReadSectionKeysW

関数名
ReadSectionKeysW
機 能
指定されたiniファイル(iniファイル形式のファイル)からセクションの全データを読み込む
書 式
#num = dllfuncw("ReadSectionKeysW", $filename, $section)
引 数
$filename
設定を読み込むファイル名
$section
読み込むセクション名
戻り値
0以上
読み込んだキーの数
-1
関数の実行に失敗
  • 引数のエラー
  • メモリ確保に失敗
  • ファイルが存在しない。またはUTF-16LEではない。
注意
全データをメモリに読み込むのでリアルタイムに変更されると値が一致しない場合があります。 32kまで読み込み可能。 ファイルが、UTF-16LEでない場合は、-1を返します。

機能概要へ戻る

ExistKeyW

関数名
ExistKeyW
機 能
ReadSectionKeysWで読み込んだデータに指定されたキーが存在するかどうかを返す。
書 式
#num = dllfuncw("ExistKeyW", $key)
引 数
$key
チェックしたいキー
戻り値

0以上ならキーは存在し、その位置を示す。(0(zero)ベースの配列に格納されている)

-1:存在していない。  -2:ReadSectionKeysが実行されていない。

注意
値を取得するにはGetKeyValueW関数を使います。

機能概要へ戻る

GetKeyValueW

関数名
GetKeyValueW
機 能
ReadSectionKeysWで読み込んだデータから指定されたキーの値を返す。
書 式
$str = dllfuncstrw("GetKeyValueW", #num)
引 数
#num
取得するキーの位置。基本的にはExistKeyW関数の戻り値を使う。
戻り値
キーの値。存在していない位置を指定した場合は""を返す。
注意

機能概要へ戻る

GetIniKeyDataW

関数名
GetIniKeyDataW
機 能
ReadSectionKeysWで読み込んだデータから"key=Value"という形式でデータを取り出す。
書 式
$str = dllfuncstrw("GetIniKeyDataW")
引 数
戻り値
"key=Value"という形式のデータ
注意
取得するデータ位置をずらすにはNextKeyW関数を使います。

機能概要へ戻る

GetIniKeyW

関数名
GetIniKeyW
機 能
ReadSectionKeysWで読み込んだデータからキーを取り出す。
書 式
$str = dllfuncstrW("GetIniKeyW")
引 数
なし
戻り値
セクションに含まれるキー
注意
取得するデータ位置をずらすにはNextKeyW関数を使います。

機能概要へ戻る

GetIniKeyValueW

関数名
GetIniKeyValueW
機 能
ReadSectionKeysWで読み込んだデータから値を取り出す。
書 式
$str = dllfuncstrw("GetIniKeyValueW")
引 数
なし
戻り値
セクションに含まれる値
注意
取得するデータ位置をずらすにはNextKeyW関数を使います。

機能概要へ戻る

NextKeyW

関数名
NextKeyW
機 能
GetIniKeyDataW、GetIniKeyW、GetIniKeyValueWで取得するキー位置を+1する。
書 式
#num = dllfunc("NextKeyW")
引 数
なし
戻り値
1:取得データあり 0:取得データなし
注意

機能概要へ戻る

ReadSectionNamesW

関数名
ReadSectionNamesW
機 能
指定されたiniファイル(iniファイル形式のファイル)から、全セクション名を取得
書 式
#num = dllfuncw("ReadSectionNamesW", $filename)
引 数
$filename
設定を読み込むファイル名
戻り値
取得したセクション数。関数が失敗した場合は-1。
注意
ファイルが、UTF-16LEでない場合は、-1を返します。

機能概要へ戻る

ExistSectionW

関数名
ExistSectionW
機 能
ReadSectionNamesWで読み込んだデータに、指定されたセクションが存在するかどうかを返す。
書 式
#num = dllfuncw("ExistSectionW", $section)
引 数
$section
チェックしたいセクション名
戻り値

0以上なら存在し、その位置を示す。(0(zero)ベースの配列に格納されている)

-1:存在していない。  -2:ReadSectionNamesWが実行されていない。

注意
値を取得するにはGetSectionNameW関数を使います。

機能概要へ戻る

GetSectionNameW

関数名
GetSectionNameW
機 能
ReadSectionNamesWで読み込んだデータから、指定されたセクション名を返す。
書 式
$str = dllfuncstrw("GetSectionNameW", #num)
引 数
#num
取得するキーの位置。基本的にはExistSectionW関数の戻り値を使う。
戻り値
セクション名。存在していない位置を指定した場合は""を返す。
注意

機能概要へ戻る

GetSectionW

関数名
GetSectionW
機 能
ReadSectionNamesWで読み込んだデータから、セクション名を返す。
書 式
$str = dllfuncstrw("GetSectionW")
引 数
なし
戻り値
セクション名
注意
取得するデータ位置を変更するにはNextSectionW関数を使います。

機能概要へ戻る

NextSectionW

関数名
NextSectionW
機 能
GetSectionWで取得する位置を変更(+1)する。
書 式
#num = dllfuncw("NextSectionW")
引 数
なし
戻り値
1:取得データあり 0:取得データなし
注意

機能概要へ戻る

WriteIniStrW

関数名
WriteIniStrW
機 能
マクロ関数writeinistrのUnicode版。iniファイルへ文字データを書き込む
書 式
#num = dllfuncw("WriteIniStrW", $inifileW, $sectionW, $keyW, $valueW)
引 数
$inifileW
iniファイル名(Unicode)
$sectionW
セクション(Unicode)
$keyW
キー(Unicode)
$valueW
値(Unicode)
戻り値
1:正常終了 0:異常終了
注意
iniファイルが存在しない場合は、自動で作成します。 ファイルが、UTF-16LEでない場合は、0を返します。

機能概要へ戻る

GetIniStrW

関数名
GetIniStrW
機 能
マクロ関数getinistrのUnicode版。iniファイルから文字データを読み込む
書 式
$str = dllfuncstrw("GetIniStrW", $inifileW, $sectionW, $keyW)
引 数
$inifileW
iniファイル名(Unicode)
$sectionW
セクション(Unicode)
$keyW
キー(Unicode)
戻り値
キーがあれば、その文字列を、なければ""を返す
注意
ファイルが、UTF-16LEでない場合は、""を返します。

機能概要へ戻る

WriteIniNumW

関数名
WriteIniNumW
機 能
マクロ関数writeininumのUnicode版。iniファイルへ数値データを書き込む
書 式
#num = dllfuncw("WriteIniNumW", $inifileW, $sectionW, $keyW, #value)
引 数
$inifileW
iniファイル名(Unicode)
$sectionW
セクション(Unicode)
$keyW
キー(Unicode)
#value
値(数値)
戻り値
1:正常終了 0:異常終了
注意
iniファイルが存在しない場合は、自動で作成します。 ファイルが、UTF-16LEでない場合は、0を返します。

機能概要へ戻る

GetIniNumW

関数名
GetIniNumW
機 能
マクロ関数getininumのUnicode版。iniファイルから数値データを読み込む
書 式
$str = dllfuncstrw("GetIniNumW", $inifileW, $sectionW, $keyW)
引 数
$inifileW
iniファイル名(Unicode)
$sectionW
セクション(Unicode)
$keyW
キー(Unicode)
戻り値
キーがあれば、その文字列を、なければ""を返す
注意
ファイルが、UTF-16LEでない場合は、""を返します。

機能概要へ戻る

ファイル操作

FileOpen

関数名
FileOpen
機 能
ファイルを指定されたモードで開く
書 式
#num = dllfunc("FileOpen", $filename, $mode)
引 数
$filename
ファイル名
$mode
オープンモード
w
書き込み
r
読み込み
a
追加書き込み
b
バイナリモード
戻り値
ファイルハンドルを返す。(1〜10)
注意
失敗すると0を返します。 同時にオープンするのは10ファイルまで

機能概要へ戻る

WrFile

関数名
WrFile
機 能
文字列をファイルに書き込む
書 式
#num = dllfunc("WrFile", #handle, $Target)
引 数
#handle
FileOpen関数で取得したファイルハンドル
$Target
書き込む文字列
戻り値
正常なら1、失敗すると0を返す。
注意
FileError関数で詳細なエラー情報を取得可能

機能概要へ戻る

WrFileLine

関数名
WrFileLine
機 能
文字列の最後が改行文字(\n)でない場合は、改行文字を追加しファイルに書き込む。
書 式
#num = dllfunc("WrFileLine", #handle, $Target)
引 数
#handle
FileOpen関数で取得したファイルハンドル
$Target
書き込む文字列
戻り値
正常なら1、失敗すると0を返す。
注意
FileError関数で詳細なエラー情報を取得可能

機能概要へ戻る

RdFile

関数名
RdFile
機 能
ファイルから1行文字列を取り込む
書 式
$str = dllfuncstr("RdFile", #handle)
引 数
#handle
FileOpen関数で取得したファイルハンドル
戻り値
改行までの文字列(改行を含む)
注意
FileError関数で詳細なエラー情報を取得可能。

機能概要へ戻る

RdFile2

関数名
RdFile2
機 能
ファイルから1行文字列を取り込む
書 式
$str = dllfuncstr("RdFile2", #handle)
引 数
#handle
FileOpen関数で取得したファイルハンドル
戻り値
改行までの文字列(改行を含まない)
注意
FileError関数で詳細なエラー情報を取得可能。

機能概要へ戻る

RdFileByte

関数名
RdFileByte
機 能
ファイルから指定バイト数を取り込む。
書 式
$str = dllfuncstr("RdFileByte", #handle, #Size)
引 数
#handle
FileOpen関数で取得したファイルハンドル
#Size
取得するバイト数
戻り値
取得した文字列
注意
FileError関数で詳細なエラー情報を取得可能。

機能概要へ戻る

FileError

関数名
FileError
機 能
ファイル関連のエラー情報取得
書 式
#num = dllfunc("FileError")
引 数
なし
戻り値
エラーコード
FIO_BUFFERR(0x01)
バッファの取得エラー
FIO_OPENERR(0x02)
オープンエラー
FIO_FILEERR(0x04)
リードエラー
FIO_EOFERR(0x08)
EOFエラー
FIO_WRERR(0x20)
ライト時のエラー
FIO_ARGVERR(0x10)
引数のエラー
FIO_CLOSEERR(0x40)
クローズ時のエラー
FIO_DELETEERR(0x80)
削除時のエラー
注意

機能概要へ戻る

IsOpen

関数名
IsOpen
機 能
ファイルハンドルの状態を返す
書 式
#num = dllfunc("IsOpen",#handle)
引 数
#handle
FileOpen関数で取得したファイルハンドル
戻り値
1:オープン 0:オープンでない
注意

機能概要へ戻る

IsFerror

関数名
IsFerror
機 能
指定されたファイルハンドルでエラーの有無を返す
書 式
#num = dllfunc("IsFerror",#handle)
引 数
#handle
FileOpen関数で取得したファイルハンドル
戻り値
1:エラーあり 0:エラーなし
注意

機能概要へ戻る

IsEof

関数名
IsEof
機 能
指定されたファイルハンドルでEOFの状態を返す
書 式
#num = dllfunc("IsEof",#handle)
引 数
#handle
FileOpen関数で取得したファイルハンドル
戻り値
1:EOF 0:EOFでない
注意

機能概要へ戻る

FileClose

関数名
FileClose
機 能
指定されたファイルハンドルを閉じる
書 式
#num = dllfunc("FileClose",#handle)
引 数
#handle
FileOpen関数で取得したファイルハンドル
戻り値
常に1を返す
注意

機能概要へ戻る

FileDelete

関数名
FileDelete
機 能
ファイルを削除する
書 式
#num = dllfunc("FileDelete",$filename)
引 数
$filename
削除するファイル名
戻り値
1:成功 0:失敗
注意

機能概要へ戻る

文字列関連

InStr

関数名
InStr
機 能
文字列の検索
書 式
#num = dllfunc("InStr", #start, $Target, $Search)
引 数
#start
検索開始位置(先頭が0です。)
$Target
検索対象文字
$Search
検索文字
戻り値
発見した位置(先頭は0)
注意
エラーがあった場合、見つからなかった場合は-1を返す。 検索開始位置が2バイト文字の下位バイト位置だった場合、次の文字から検索します。

機能概要へ戻る

InStrEx

関数名
InStrEx
機 能
文字列の検索(検索オプション付き)
書 式
#num = dllfunc("InStrEx", #start, $Target, $Search, #option)
引 数
#start
検索開始位置(先頭が0です。)
$Target
検索対象文字
$Search
検索文字
#option

検索オプション

0:検索文字そのもの
1:半角、全角の大文字小文字の違いを無視
2:半角のみ大文字小文字の違いを無視
3:全角のみ大文字小文字の違いを無視
戻り値
発見した位置(先頭は0)
注意
エラーがあった場合、見つからなかった場合は-1を返す。 検索開始位置が2バイト文字の下位バイト位置だった場合、次の文字から検索します。 検索オプションにより、検索対象文字列の大文字小文字を無視できます。

機能概要へ戻る

InStrRev

関数名
InStrRev
機 能
文字列の検索(最期に見つかった場所を返す)
書 式
#num = dllfunc("InStrRev", $Target, $Search)
引 数
$Target
検索対象文字
$Search
検索文字
戻り値
発見した位置(先頭は0)
注意
エラーがあった場合、見つからなかった場合は-1を返す。

機能概要へ戻る

InStrRevEx

関数名
InStrRevEx
機 能
文字列の検索(最期に見つかった場所を返す。検索オプション付き)
書 式
#num = dllfunc("InStrRevEx", $Target, $Search, #option)
引 数
$Target
検索対象文字
$Search
検索文字
#option

検索オプション

0:検索文字そのもの
1:半角、全角の大文字小文字の違いを無視
2:半角のみ大文字小文字の違いを無視
3:全角のみ大文字小文字の違いを無視
戻り値
発見した位置(先頭は0)
注意
エラーがあった場合、見つからなかった場合は-1を返す。 検索開始位置が2バイト文字の下位バイト位置だった場合、次の文字から検索します。 検索オプションにより、検索対象文字列の大文字小文字を無視できます。

機能概要へ戻る

TrimStr

関数名
TrimStr
機 能
対象文字列の両端にある文字を削除
書 式
$str = dllfuncstr("TrimStr", $Target, $Delete)
引 数
$Target
検索対象文字
$Delete
削除文字
戻り値
削除した文字列
注意
削除文字があれば削除して、なければ対象文字列をそのまま返す。 大文字小文字を区別します。

機能概要へ戻る

GetStrCSpn

関数名
GetStrCSpn
機 能
対象文字列から検索文字列うちどれか1文字を見つけた位置を返す。
書 式
#n = dllfunc("GetStrCSpn", $Target, $Search)
引 数
$Target
検索対象文字
$Search
検索文字列
戻り値
一番最初に発見した位置(先頭は0)
注意
検索文字列が"ABCD"だと、対象文字列から"A" or "B" or "C" or "D"を検索。

機能概要へ戻る

GetStrSpn

関数名
GetStrSpn
機 能
対象文字列から検索文字列うちどれか1文字に該当しない文字を見つけた位置を返す。
書 式
#n = dllfunc("GetStrSpn", $Target, $Search)
引 数
$Target
検索対象文字
$Search
検索文字列
戻り値
一番最初に発見した位置(先頭は0)
注意
検索文字列が"ABCD"だと、対象文字列から"A" and "B" and "C" and "D" 以外を検索。

機能概要へ戻る

InsertStr

関数名
InsertStr
機 能
文字列の挿入
書 式
$str = dllfuncstr("InsertStr", $Target, #Number, $Ins)
引 数
$Target
対象文字
#number
挿入位置(先頭が0(zero))
$Ins
挿入文字
戻り値
変更した文字列
注意
エラーがあった場合""を返します。 2バイト文字の下位バイトにあたる位置に挿入はできません。 下位バイト位置が指定された場合、次の文字が挿入位置になります。

機能概要へ戻る

DeleteStr

関数名
DeleteStr
機 能
文字列の削除
書 式
$str = dllfuncstr("DeleteStr", $Target, #Number, #Length)
引 数
$Target
対象文字
#number
削除先頭位置(先頭が0(zero))
#Length
削除する文字数
戻り値
変更した文字列
注意
エラーがあった場合""を返します。 2バイト文字の下位バイトにあたる位置を削除先頭位置に指定できません。 下位バイト位置に指定された場合、削除先頭位置は次の文字になります。

機能概要へ戻る

LeftJust

関数名
LeftJust
機 能
指定した幅で左寄せ
書 式
$str = dllfuncstr("LeftJust", $Target, #Length)
引 数
$Target
対象文字
#Length
左寄せする幅の指定
戻り値
指定した幅で左寄せした文字列
注意
#Lengthは1024より大きい値は指定できません。

機能概要へ戻る

RightJust

関数名
RightJust
機 能
指定した幅で右寄せ
書 式
$str = dllfuncstr("RightJust", $Target, #Length)
引 数
$Target
対象文字
#Length
右寄せする幅の指定
戻り値
指定した幅で右寄せした文字列
注意
#Lengthは1024より大きい値は指定できません。

機能概要へ戻る

Centor

関数名
Centor
機 能
指定した幅で中央揃えにする
書 式
$str = dllfuncstr("Centor", $Target, #Length)
引 数
$Target
対象文字
#Length
中央揃えにする幅の指定
戻り値
指定した幅で中央揃えした文字列
注意
#Lengthは1024より大きい値は指定できません。

機能概要へ戻る

UpperStr

関数名
UpperStr
機 能
指定された文字を大文字へ変換
書 式
$str = dllfuncstr("UpperStr", $Target, #option)
引 数
$Target
対象文字
#option

検索オプション

0:半角、全角を対象
1:半角のみ
2:全角のみ
戻り値
大文字に変換された文字列
注意

機能概要へ戻る

LowerStr

関数名
LowerStr
機 能
指定された文字を小文字へ変換
書 式
$str = dllfuncstr("LowerStr", $Target, #option)
引 数
$Target
対象文字
#option

検索オプション

0:半角、全角を対象
1:半角のみ
2:全角のみ
戻り値
小文字に変換された文字列
注意

機能概要へ戻る

Trim

関数名
Trim
機 能
両端の空白を削除。 空白とはタブ、改行、空白 全角空白(0x09〜0x0d、0x21、0x8140)です。
書 式
$str = dllfuncstr("Trim", $Target)
引 数
$Target
対象文字
戻り値
空白を取り除いた文字列
注意

機能概要へ戻る

LTrim

関数名
LTrim
機 能
左側の空白を削除。 空白とはタブ、改行、空白 全角空白(0x09〜0x0d、0x21、0x8140)です。
書 式
$str = dllfuncstr("LTrim", $Target)
引 数
$Target
対象文字
戻り値
空白を取り除いた文字列
注意

機能概要へ戻る

RTrim

関数名
RTrim
機 能
右側の空白を削除。 空白とはタブ、改行、空白 全角空白(0x09〜0x0d、0x21、0x8140)です。
書 式
$str = dllfuncstr("RTrim", $Target)
引 数
$Target
対象文字
戻り値
空白を取り除いた文字列
注意

機能概要へ戻る

String

関数名
String
機 能
指定した回数分連続した文字列を返します。
書 式
$str = dllfuncstr("String", #repeat, $str)
引 数
#repeat
繰り返し数
$str
繰り返す文字
戻り値
指定回数繰り返された文字列
注意
先頭の1文字をしか使用しません。(全角の場合も1文字です。)

機能概要へ戻る

Strings

関数名
Strings
機 能
指定した回数分連続した文字列を返します。
書 式
$str = dllfuncstr("Strings", #repeat, $str)
引 数
#repeat
繰り返し数
$str
繰り返す文字列
戻り値
指定回数繰り返された文字列
注意
文字列全体を繰り返しの対象にします。

機能概要へ戻る

Replace

関数名
Replace
機 能
文字列を置き換える
書 式
$str = dllfuncstr("Replace", $Target, $Search, $Replace, #cnt)
引 数
$Target
対象文字列
$Search
検索文字列
$Replace
置き換え文字列
#cnt
置き換え回数 -1を指定すると全て、0以上は指定された回数置き換えを行う。
戻り値

置換された文字列

検索文字列が見つからない場合は、対象文字列を返します。 何かしらのエラーがある場合は""を返します。

注意

#cntに0を指定すると0回なので元の文字列をそのまま返します。

$Searchに""を指定すると元の文字列をそのまま返します。

機能概要へ戻る

SetUTF8ConvertString

関数名
SetUTF8ConvertString
機 能
UTF-16LEからUTF-8へ変換する。
書 式
#num = dllfuncw("SetUTF8ConvertString", $WString)
引 数
$WString
変換対象対象文字列(UTF-16LE文字列)
戻り値
変換に成功すれば1、失敗した場合は0
注意

dllfuncwを使用して呼び出してください。 変換結果を取得するには、GetResultを使用します。

#ret = dllfuncw("SetUTF8ConvertString", "秀丸エディタ");
$utf8 = dllfuncstr("GetResult");

機能概要へ戻る

SetUTF16ConvertString

関数名
SetUTF16ConvertString
機 能
UTF-8からUTF-16LEへ変換する。
書 式
#num = dllfunc("SetUTF16ConvertString", $String)
引 数
$String
変換対象対象文字列(UTF-8文字列)
戻り値
変換に成功すれば1、失敗した場合は0
注意

変換結果を取得するには、GetResultWを使用します。

$utf8 = getinistr($inifile, $section, "utf8");
#ret = dllfunc("SetUTF16ConvertString", $utf8);
$utf16 = dllfuncstrw("GetResultW");

機能概要へ戻る

GetResult

関数名
GetResult
機 能
SetUTF8ConvertStringの変換結果を取得する。
書 式
$str = dllfuncstr("GetResult")
引 数
なし
戻り値
SetUTF8ConvertStringの変換結果
注意

機能概要へ戻る

GetResultW

関数名
GetResultW
機 能
SetUTF16ConvertStringの変換結果を取得する。
書 式
$str = dllfuncstrw("GetResultW")
引 数
なし
戻り値
SetUTF16ConvertStringの変換結果
注意
dllfuncwを使用して呼び出してください。

機能概要へ戻る

nkf関連

nkf_load

関数名
nkf_load
機 能
nkf32.dllをロードし、各種関数を使用できるようにする。
書 式
#num = dllfunc("nkf_load", $filename)
引 数
$filename
読み込む"nkf32.dll"をフルパスで指定する。 省略した場合、Windowsの標準動作に従い、nkf32.dll"のロード行います。
戻り値
ロードに成功すれば1、失敗だと0
注意

例)

#num = dllfunc("nkf_load");   //nkf32.dllがパスの通った場所にある場合。
#num = dllfunc("nkf_load","");//nkf32.dllがパスの通った場所にある場合。
#num = dllfunc("nkf_load",hidemarudir + "\\nkf32.dll");   //nkf32.dllのパスを指定する場合

機能概要へ戻る

nkf_free

関数名
nkf_free
機 能
nkf32.dllをアンロードする。
書 式
#num = dllfunc("nkf_free")
引 数
なし
戻り値
常に1を返す。
注意

機能概要へ戻る

nkf_version

関数名
nkf_version
機 能
nkf32.dllのバージョン情報を文字列で返す。
書 式
$str = dllfuncstr("nkf_version")
引 数
なし
戻り値
バージョン情報を文字列で返します。
注意

機能概要へ戻る

nkf_exec

関数名
nkf_exec
機 能
nkfコマンドの実行
書 式
$str = dllfuncstr("nkf_exec", $Option, $Target)
引 数
$Option
nkfへのオプション文字列
$Target
対象文字列
戻り値
変換結果を文字列で返す。
注意
nkf_load関数を実行していないと""を返します。 エラーの有無と詳細はnkf_error関数で取得できる。 オプションの指定はNKF32.DLLのドキュメントを参照してください。

機能概要へ戻る

nkf_tohankaku

関数名
nkf_tohankaku
機 能
2バイト文字の英数字と一部の記号を1バイト文字へ変換
書 式
$str = dllfuncstr("nkf_tohankaku", $Target)
引 数
$Target
対象文字列
戻り値
変換結果を文字列で返す。
注意
nkf_load関数を実行していないと""を返します。 エラーの有無と詳細はnkf_error関数で取得可能。

機能概要へ戻る

nkf_tozenkakukana

関数名
nkf_tozenkakukana
機 能
1バイトカナ文字を2バイト文字へ変換
書 式
$str = dllfuncstr("nkf_tozenkakukana", $Target)
引 数
$Target
対象文字列
戻り値
変換結果を文字列で返す。
注意
nkf_load関数を実行していないと""を返します。 エラーの有無と詳細はnkf_error関数で取得可能。

機能概要へ戻る

nkf_tomime

関数名
nkf_tomime
機 能
MIME(BASE64)形式の文字列に変換
書 式
$str = dllfuncstr("nkf_tomime", $Target)
引 数
$Target
対象文字列
戻り値
変換結果を文字列で返す。
注意
nkf_load関数を実行していないと""を返します。 エラーの有無と詳細はnkf_error関数で取得可能。

機能概要へ戻る

nkf_error

関数名
nkf_error
機 能
nkf関連コマンドのエラー情報を返す。
書 式
#num = dllfunc("nkf_error")
引 数
なし
戻り値
エラーコード
NKF_NOERROR(0x00)
エラーなし
NKF_OPTIONERROR(0x01)
オプション文字列の設定エラー
NKF_ARGVERROR(0x02)
各種引数のエラー
NKF_LOADERROR(0x03)
DLLのロードエラー
NKF_COMMANDERROR(0x04)
各コマンドの実行エラー
NKF_FUNCTIONERROR(0x05)
DLLの関数ポインタ取得エラー
NKF_VERIONERROR(0x06)
DLLのバージョン不一致
NKF_INFILEERROR(0x07)
入力ファイルのエラー
NKF_OUTFILEERROR(0x08)
出力ファイルのエラー
注意

機能概要へ戻る

nkf_errormessage

関数名
nkf_errormessage
機 能
nkfコマンドのエラーメッセージを返す。
書 式
$str = dllfuncstr("nkf_errormessage")
引 数
なし
戻り値
エラーメッセージ
注意

機能概要へ戻る

nkf_getkanjicode

関数名
nkf_getkanjicode
機 能
nkfコマンド実行時、対象文字列の漢字コードを取得する。
書 式
#num = dllfunc("nkf_getkanjicode")
引 数
なし
戻り値
-1
nkf32.dll Ver 1.03 で実行した場合か、nkd_load を行っていない場合。
0
shift-jis
1
euc
2
jis
3
utf-8
4
utf-16LE
5
utf-16BE
注意
nkf32.dll がVer.2以降でないと動作しません。 nkfの各コマンドを実行後に呼びだすこと。

機能概要へ戻る

nkf_fileconvert1

関数名
nkf_fileconvert1
機 能
ファイルを対象にしたnkfコマンドの実行。ファイル自体を置き換えます。
書 式
#num = dllfunc("nkf_fileconvert1", $TargetFile, $Option)
引 数
$TargetFile
変換対象のファイル名
$Option
nkfへのオプション
戻り値
0
  • ファイルが存在しない。
  • オプション設定エラー。
  • Ver.1系で実行。
  • DLLをロードしていない。
1
nkfコマンド実行。
注意
nkf32.dll がVer.2以降でないと動作しません。

機能概要へ戻る

nkf_fileconvert2

関数名
nkf_fileconvert2
機 能
ファイルを対象にしたnkfコマンドの実行。出力ファイルを指定する。
書 式
#num = dllfunc("nkf_fileconvert2", $InFile, $OutFile, $Option)
引 数
$InFile
入力ァイル名
$OutFile
出力ファイル名
$Option
nkfへのオプション
戻り値
0
  • 入力ファイルが存在しない。
  • 出力ファイルが存在している。
  • 出力ファイルが指定されていない。
  • オプション設定エラー。
  • Ver.1系で実行。
  • DLLをロードしていない。
1
nkfコマンド実行。
注意
nkf32.dll がVer.2以降でないと動作しません。 出力ファイルへの上書きは行いません。

機能概要へ戻る

nkf_getguess

関数名
nkf_getguess
機 能
nkfコマンド実行時、対象文字列の漢字コードを文字列で取得する。
書 式
$str = dllfuncstr("nkf_getguess")
引 数
なし
戻り値
自動判定した結果を文字列で返します。("Shift-JIS"等) nkf32.dll Ver 1.03 で実行した場合か、nkd_load を行っていない場合は、""を返します。
注意
nkf32.dll がVer.2.0.5以降でないと動作しません。 nkfの各コマンドを実行後に呼びだすこと。

nkf_getmodulefilename

関数名
nkf_getmodulefilename
機 能
ロードしたnkf32.dllのフルパスを返す。
書 式
$str = dllfuncstr("nkf_getmodulefilename")
引 数
なし
戻り値
ロードしたnkf32.dllのフルパスを返します。 nkf_load を行っていない、または失敗している場合は、""を返します。
注意

機能概要へ戻る

hmjre関連

hmjre_version

関数名
hmjre_version
機 能
hmjre.dllのバージョンを文字列で返す。
書 式
$str = dllfuncstr("hmjre_version")
引 数
なし
戻り値
バージョン番号
注意

機能概要へ戻る

hmjre_load

関数名
hmjre_load
機 能
hmjre.dllをロードし、各種関数を使用できるようにする。
書 式
#num = dllfunc("hmjre_load", $filename)
引 数
$Filename

hmjre.dllの場所

""だとDLLを検索します。

戻り値
ロードに成功すれば1、失敗だと0
注意
DLLは一般的な場所、秀丸エディタ、秀丸メールの順で検索します。 なるべくファイルを指定して下さい。 通常は hidemarudir + "\\hmjre.dll" と指定すればいい。

機能概要へ戻る

hmjre_free

関数名
hmjre_free
機 能
hmjre.dllをアンロードする。
書 式
#num = dllfunc("hmjre_free")
引 数
なし
戻り値
常に1を返す。
注意

機能概要へ戻る

hmjre_match

関数名
hmjre_match
機 能
hmjre.dllを使った検索
書 式
#num = dllfunc("hmjre_match", $target, $search, #flag, #start)
引 数
$target
検索対象文字列
$search
正規表現
#flag
大文字/小文字を無視するフラグ。1 で大文字小文字を無視。
#start
検索開始位置
戻り値
-1
エラー
0
一致する文字がない。または""に一致。
1
一致する文字あり
注意
一度検索して、$target、$searchに""を指定して呼びだすと同じ条件で マッチした文字列の後から再度検索します。この場合、#flag、#startは無視されます。

機能概要へ戻る

hmjre_match_string

関数名
hmjre_match_string
機 能
hmjre_match関数で一致した文字列を取得
書 式
$str = dllfuncstr("hmjre_match_string")
引 数
なし
戻り値
一致した文字列。 検索していない場合は""を返す。
注意

機能概要へ戻る

hmjre_match_info

関数名
hmjre_match_info
機 能
hmjre_match関数で一致した文字列の位置情報を返す。
書 式
#num = dllfuncstr("hmjre_match_info", $target)
引 数
$target
position または p
一致した文字列の位置。先頭が"0"になります。
length または l
一致した文字列の長さ。
戻り値
一致した文字列の位置。または、一致した文字列の長さ。
注意

機能概要へ戻る

hmjre_match_tag_string

関数名
hmjre_match_tag_string
機 能
hmjre_match関数で、タグに一致した文字列を取得
書 式
$str = dllfuncstr("hmjre_match_tag_string",#num)
引 数
#num
取り出したいタグの番号
戻り値
タグに一致した文字列。 検索していない(hmjre_matchを実行していない)場合は""を返す。
注意
指定されたタグがない場合は、""を返す。

機能概要へ戻る

mecab関連

mecab_load

関数名
mecab_load
機 能
mecab(libmecab.dll)をロードし、各種関数を使用できるようにする。
書 式
#num = dllfunc("mecab_load",$filename)
引 数
$filename
読み込む"libmecab.dll"をフルパスで指定する。 省略した場合、Windowsの標準動作に従い、"libmecab.dll"のロード行います。
戻り値
ロードに成功すれば1、失敗だと0
注意

resource fileを指定する場合は、各コマンドのオプションで指定して下さい。 例)

#num = dllfunc("mecab_load");   //libmecab.dllがパスの通った場所にある場合。
#num = dllfunc("mecab_load","");//libmecab.dllがパスの通った場所にある場合。
#num = dllfunc("mecab_load",hidemarudir + "\\libmecab.dll");   //libmecab.dllのパスを指定する場合

機能概要へ戻る

mecab_free

関数名
mecab_free
機 能
mecab(libmecab.dll)をアンロードする。
書 式
#num = dllfunc("mecab_free")
引 数
なし
戻り値
常に1を返す。
注意

機能概要へ戻る

mecab_version

関数名
mecab_version
機 能
mecab(libmecab.dll)のバージョン情報を文字列で返す。
書 式
$str = dllfuncstr("mecab_version")
引 数
なし
戻り値
バージョン情報を文字列で返します。
注意

機能概要へ戻る

mecab

関数名
mecab
機 能
mecabコマンドの実行(最適解のみ)
書 式
$str = dllfuncstr("mecab", $Option, $Target)
引 数
$Option
mecabへのオプション文字列
$Target
対象文字列
戻り値
解析結果を返す。
注意
mecab_load関数を実行していないと""を返します。 エラーの有無と詳細はmecab_error、mecab_errormessage、mecab_getstrerror関数で取得可能。 オプションの指定はmecabのドキュメントを参照してください。 複数の解析結果を得たい場合は、mecab_nbestを使用して下さい。

機能概要へ戻る

mecab_getyomi

関数名
mecab_getyomi
機 能
対処文字列の読みを返す。(最適解のみ)
書 式
$str = dllfuncstr("mecab_getyomi", $Option, $Target)
引 数
$Option
追加するオプション。追加しない場合は""を指定すること。
$Target
対象文字列
戻り値
読みを文字列で返す。
注意
mecabコマンドを、オプション"-O yomi"を追加して実行しています。 mecab_load関数を実行していないと""を返します。 エラーの有無と詳細はmecab_error、mecab_errormessage、mecab_getstrerror関数で取得可能。

機能概要へ戻る

mecab_wakati

関数名
mecab_wakati
機 能
対象文字列を、意味のある単語毎に、スペースで区切る。
書 式
$str = dllfuncstr("mecab_wakati", $Option, $Target)
引 数
$Option
追加するオプション。追加しない場合は""を指定すること。
$Target
対象文字列
戻り値
わかち書きした結果を返す。
注意
mecabコマンドを、オプション"O wakati"を追加して実行しています。 mecab_load関数を実行していないと""を返します。 エラーの有無と詳細はmecab_error、mecab_errormessage、mecab_getstrerror関数で取得可能。

機能概要へ戻る

mecab_nbest

関数名
mecab_nbest
機 能
mecabコマンドの実行(複数の解析結果を取得)
書 式
$str = dllfuncstr("mecab_nbest", $Option, $Target, #Num)
引 数
$Option
mecabへのオプション文字列
$Target
対象文字列
#Num
取得したい結果の数(MAX 512)
戻り値
指定された個数の解析結果を返す。
注意
mecab_load関数を実行していないと""を返します。 エラーの有無と詳細はmecab_error、mecab_errormessage、mecab_getstrerror関数で取得可能。

機能概要へ戻る

mecab_error

関数名
mecab_error
機 能
mecabコマンドのエラー情報を返す。
書 式
#num = dllfunc("mecab_error")
引 数
なし
戻り値
エラーコード
MECAB_NOERROR(0x00)
エラーなし
MECAB_OPTIONERROR(0x01)
オプション文字列の設定エラー
MECAB_ARGVERROR(0x02)
各種引数のエラー
MECAB_LOADERROR(0x03)
DLLのロードエラー
MECAB_COMMANDERROR(0x04)
各コマンドの実行エラー
MECAB_FUNCTIONERROR(0x05)
DLLの関数ポインタ取得エラー
MECAB_VERIONERROR(0x06)
DLLのバージョン不一致
MECAB_MAKERROR(0x07)
mecabのインスタンス作成エラー
注意

機能概要へ戻る

mecab_errormessage

関数名
mecab_errormessage
機 能
mecabコマンドのエラーメッセージを文字列で返す。
書 式
$str = dllfuncstr("mecab_errormessage")
引 数
なし
戻り値
エラーメッセージ
注意

機能概要へ戻る

mecab_getstrerror

関数名
mecab_getstrerror
機 能
mecabコマンドのエラーメッセージを文字列で返す。(mecabが出力するメッセージ)
書 式
$str = dllfuncstr("mecab_getstrerror")
引 数
なし
戻り値
エラーメッセージ
注意

機能概要へ戻る

mecab_getmodulefilename

関数名
mecab_getmodulefilename
機 能
ロードしたlibmecab.dllのフルパスを返す。
書 式
$str = dllfuncstr("mecab_getmodulefilename")
引 数
なし
戻り値
ロードしたlibmecab.dllのフルパスを返します。 mecab_load を行っていない、または失敗している場合は、""を返します。
注意

機能概要へ戻る

hunspell関連

hunspell_load

関数名
hunspell_load
機 能
hunspell(libhumspell.dll)をロードし、各種関数を使用できるようにする。
書 式
#num = dllfunc("hunspell_load",$filename)
引 数
$filename
読み込む"libhumspell.dll"をフルパスで指定する。 省略した場合、Windowsの標準動作に従い、"libhumspell.dll"のロード行います。
戻り値
ロードに成功すれば1、失敗だと0
注意

機能概要へ戻る

hunspell_free

関数名
hunspell_free
機 能
hunspell(libhumspell.dll)をアンロードする。
書 式
#num = dllfunc("hunspell_free")
引 数
なし
戻り値
常に1を返す。
注意

機能概要へ戻る

hunspell_Create

関数名
hunspell_Create
機 能
指定された辞書を使用し、スペルチェッククラスを生成する。
書 式
#num = dllfunc("hunspell_Create", $Dictionary, $Affix)
引 数
$Dictionary
スペルチェックに使用する辞書を指定する。
$Affix
省略可能。スペルチェックに使用する接辞ファイルを指定する。
戻り値
スペルチェッククラスの生成に成功すれば 1、失敗の場合は 0を返す。
注意
$Dictionary(辞書ファイル) と $Affix(接辞ファイル) の指定について。

機能概要へ戻る

hunspell_Get_Dic_Encoding

関数名
hunspell_Get_Dic_Encoding
機 能
読み込んだ辞書のエンコードを返す。
書 式
$str = dllfuncstr("hunspell_Get_Dic_Encoding")
引 数
なし
戻り値
エンコードを示す文字列。 hunspell_Createを実行していない、または実行に失敗している場合には、""を返す。
注意
辞書のエンコードが、"UTF-8"の場合は、unicode版関数(末尾に"W"がついている関数)を使用してください。 内部で、UTF-16LE -> UTF-8 の変換を行っています。

機能概要へ戻る

hunspell_Spell

関数名
hunspell_Spell
機 能
スペルチェックを実行する。
書 式
#num = dllfunc("hunspell_Spell", $word)
引 数
$word
スペルチェックする語句
戻り値
問題があれば 1、なければ 0を返す。 エラーがあった場合は -1 を返す。
注意

機能概要へ戻る

hunspell_Suggest

関数名
hunspell_Suggest
機 能
語句のサジェスト候補を調べる。
書 式
#num = dllfunc("hunspell_Suggest", $word)
引 数
$word
実施する語句を指定する。
戻り値
サジェスト候補があればその数を、なければ 0を返す。 エラーがあった場合は -1 を返す。
注意

機能概要へ戻る

hunspell_SuggestList

関数名
hunspell_SuggestList
機 能
サジェスト候補を取得する。
書 式
$str = dllfuncstr("hunspell_SuggestList", #num)
引 数
#num
サジェスト候補の番号
戻り値
サジェスト候補
注意
hunspell_Suggest を実行していない場合は"" を返す。

機能概要へ戻る

hunspell_Add

関数名
hunspell_Add
機 能
単語を辞書に登録する。
書 式
#num = dllfunc("hunspell_Add", $word)
引 数
$word
追加する単語を指定する。
戻り値
成功すれば 1、失敗の場合は 0を返す。 エラーがあった場合は -1 を返す。
注意

機能概要へ戻る

hunspell_Remove

関数名
hunspell_Remove
機 能
単語を辞書から削除する。
書 式
#num = dllfunc("hunspell_Remove", $word)
引 数
$word
削除する単語を指定する。
戻り値
成功すれば 1、失敗の場合は 0を返す。 エラーがあった場合は -1 を返す。
注意

機能概要へ戻る

hunspell_AddDictionary

関数名
hunspell_AddDictionary
機 能
辞書ファイルを追加する。
書 式
#num = dllfunc("hunspell_AddDictionary", $Dictionary)
引 数
$Dictionary
追加する辞書ファイル名
戻り値
成功すれば 1、失敗の場合は 0を返す。 エラーがあった場合は -1 を返す。
注意

この関数を使用するには、改造版libhunspell.dllが必要です。

辞書ファイルは、hunspellの辞書と同じ形式のファイルを指定して下さい。

機能概要へ戻る

hunspell_getmodulefilename

関数名
hunspell_getmodulefilename
機 能
ロードしたlibhumspell.dllのフルパスを返す。
書 式
$str = dllfuncstr("hunspell_getmodulefilename")
引 数
なし
戻り値
ロードしたlibhumspell.dllのフルパスを返します。 hunspell_load を行っていない、または失敗している場合は、""を返します。
注意

機能概要へ戻る

hunspell_errormessage

関数名
hunspell_errormessage
機 能
hunspell関連関数のエラーメッセージを返す。
書 式
$str = dllfuncstr("hunspell_errormessage")
引 数
なし
戻り値
hunspell関連関数のエラーメッセージ。
注意

機能概要へ戻る

hunspell_SpellW

関数名
hunspell_SpellW
機 能
スペルチェックを実行する。
書 式
#num = dllfuncw("hunspell_SpellW", $word)
引 数
$word
スペルチェックする語句
戻り値
問題があれば 1、なければ 0を返す。 エラーがあった場合は -1 を返す。
注意
dllfuncwを使用して呼び出してください。

機能概要へ戻る

hunspell_SuggestW

関数名
hunspell_SuggestW
機 能
語句のサジェスト候補を調べる。
書 式
#num = dllfuncw("hunspell_SuggestW", $word)
引 数
$word
実施する語句を指定する。
戻り値
サジェスト候補があればその数を、なければ 0を返す。 エラーがあった場合は -1 を返す。
注意
dllfuncwを使用して呼び出してください。

機能概要へ戻る

hunspell_SuggestListW

関数名
hunspell_SuggestListW
機 能
サジェスト候補を取得する。
書 式
$str = dllfuncstrw("hunspell_SuggestListW", #num)
引 数
#num
サジェスト候補の番号
戻り値
サジェスト候補
注意
dllfuncstrwを使用して呼び出してください。
hunspell_Suggest を実行していない場合は"" を返す。

機能概要へ戻る

hunspell_AddW

関数名
hunspell_AddW
機 能
単語を辞書に登録する。
書 式
#num = dllfuncw("hunspell_AddW", $word)
引 数
$word
追加する単語を指定する。
戻り値
成功すれば 1、失敗の場合は 0を返す。 エラーがあった場合は -1 を返す。
注意
dllfuncwを使用して呼び出してください。

機能概要へ戻る

hunspell_RemoveW

関数名
hunspell_RemoveW
機 能
単語を辞書から削除する。
書 式
#num = dllfuncw("hunspell_RemoveW", $word)
引 数
$word
削除する単語を指定する。
戻り値
成功すれば 1、失敗の場合は 0を返す。 エラーがあった場合は -1 を返す。
注意
dllfuncwを使用して呼び出してください。

機能概要へ戻る

hunspell_GetVersion

関数名
hunspell_GetVersion
機 能
ロードしたlibhumspell.dllのバージョンを文字列で返す。
書 式
$str = dllfuncstr("hunspell_GetVersion")
引 数
なし
戻り値
ロードしたlibhumspell.dllのバージョンを文字列で返す。 hunspell_load を行っていない、または失敗している場合は、""を返します。
注意
この関数を使用するには、改造版libhunspell.dllが必要です。

機能概要へ戻る

EditorConfig関連

EditorConfigExecute

関数名
EditorConfigExecute
機 能
.editorconfigを検索し、適応するプロパティを取得する。
書 式
#num = dllfunc("ditorConfigExecute",$filename)
引 数
$filename
対象となるファイル(フルパスで指定すること。)
戻り値
適応するプロパティの数。エラーの場合は-1を返す。
注意

実行例

#ec = loaddll(hidemarudir + "\\ht_tools.dll");
#max = dllfunc(#ec, "EditorConfigExecute", filename);
if(#max == 0){
    freedll #ec;
    endmacro;
}else if(#max == -1){
    message dllfuncstr(#ec, "EditorConfigErrorMessage");
    freedll #ec;
    endmacro;
}
#cnt = 0;
while(#cnt < #max){
    $key   = tolower(dllfuncstr(#ec, "EditorConfigGetKey",   #cnt));
    $value = tolower(dllfuncstr(#ec, "EditorConfigGetValue", #cnt));
    message $key + ":" + $value;
    #cnt = #cnt + 1;
}

機能概要へ戻る

EditorConfigErrorMessage

関数名
EditorConfigErrorMessage
機 能
EditorConfigのエラーメッセージを返す。
書 式
$str = dllfuncstr("EditorConfigErrorMessage")
引 数
なし
戻り値
エラーメッセージ
注意

機能概要へ戻る

EditorConfigGetKey

関数名
EditorConfigGetKey
機 能
EditorConfigExecuteで取得したプロパティの、キー名を返す。
書 式
$str = dllfuncstr("EditorConfigGetKey", #num)
引 数
#num
インデックス
戻り値
プロパティの、キー名を返す。
注意

機能概要へ戻る

EditorConfigGetValue

関数名
EditorConfigGetValue
機 能
EditorConfigExecuteで取得したプロパティの、値を返す。
書 式
$str = dllfuncstr("EditorConfigGetValue", #num)
引 数
#num
インデックス
戻り値
プロパティの、値を返す。
注意

機能概要へ戻る

EditorConfigClear

関数名
EditorConfigClear
機 能
EditorConfigExecuteで取得したプロパティの、キー、値を破棄する。
書 式
#num = dllfunc("EditorConfigClear")
引 数
なし
戻り値
常に1を返す。
注意

機能概要へ戻る

EditorConfigGetVersionStr

関数名
EditorConfigGetVersionStr
機 能
使用している"EditorConfig C Core"のバージョン情報を返す。
書 式
$str = dllfuncstr("EditorConfigGetVersionStr")
引 数
なし
戻り値
"EditorConfig C Core"のバージョン情報
注意

機能概要へ戻る

EditorConfigGetPcreVersionStr

関数名
EditorConfigGetPcreVersionStr
機 能
"EditorConfig C Core"で使用しているのPCREバージョン情報を返す。
書 式
$str = dllfuncstr("EditorConfigGetPcreVersionStr")
引 数
なし
戻り値
"EditorConfig C Core"で使用しているのPCREバージョン情報
注意

機能概要へ戻る

page top

使用上の注意

page top

メモ

漢数字

このプログラムでは、漢字の"一"から"九"と0(zero)を示す記号の"〇"で、位取り記数法で
示したものをさします。1999年は一九九九年となる。

漢字表記

このプログラムでは、「十百千万億兆」等の位取りの漢字を用いた数字表現をさします。
1999年は千九百九十九年となる。

page top

履 歴

2002/04/13 Version 1.0.0
初 版
2002/04/15 Version 1.0.1
CountTopWindow関数の値がおかしかったのを修正
2002/04/15 Version 1.1.0
GetWindowCaption関数を追加
2002/04/16 Version 1.1.0a
この文章のGetWindowCaption関数の説明、その他いろいろ修正・加筆
2002/04/24 Version 1.1.0b
この文章の修正
2002/05/30 Version 1.1.0c
この文章、IsTopWindows関数の説明を修正
2002/06/07 Version 1.1.1
Wait関数の追加。この文章の修正
2003/02/17 Version 1.2.0

ファイル名操作関係を追加。(文字列操作もこっそり追加) GetChangeFileExt, GetFileName, GetParentFolder, IsMatchFileName, GetFileExtention, GetFileBaseName, GetShortFileName, GetLongFileName を追加。

このバージョンからいっそう環境を選ぶようになると思う。要IE5以上。

2003/02/18 Version 1.2.1
InStr関数の追加。(本来は1.2.0でこれを追加するはずだったんだけどバグ取りに時間がかかった。)
2003/02/19 Version 1.2.2
InStrRev、TrimStr関数の追加。 InStrも"strstr"(標準関数)ではなくて"StrStr"(SHLWAPI.DLL内関数)を使えばもっと簡単になりそう。
2003/02/22 Version 1.2.3
「GetShortFileName,GetLongFileName」を「GetShortName,GetLongName」へ変更。 GetExpandPath, GetSpecialFolder, URLExchange, UrlEncode, UrlDecode, GetStrCSpn, GetStrSpn, を追加。
2003/03/01 Version 1.2.4
InsertStr、DeleteStr関数を追加。 UrlEncodeの注意を追加。
2003/03/08 Version 1.2.5
このバージョンでなんとかWindows2000以外でも動くようにしたつもり。 ただしWindows95、とXPは全然未確認。XPはたぶん大丈夫だと思うけどね。
2003/03/11 Version 1.2.6

InStr関数の検索開始位置を"0"からにした。(戻り値と同じ考え) 関数の説明にも明記するようにした。

GetDllVersion関数の戻り値を数字に変更。ついでにht_version関数を復活。

2003/03/16 Version 1.2.7
InStrI、InStrRevIを追加。
2003/03/19 Version 1.2.8
GetFileSizeByte、 GetFileSizeStr、 GetUnitStr、 GetSizeStr、 LeftJust、 RightJust を追加。
2003/03/24 Version 1.2.9
2003/03/29 Version 1.03.00
2003/04/05 Version 1.04.00
2003/04/11 Version 1.05.00
2003/06/01 Version 1.06.00
2003/06/14 Version 1.06.01
2003/07/07 Version 1.06.02
2003/08/09 Version 1.07.00
2003/08/16 Version 1.08.00
2003/08/20 Version 1.09.00
2003/11/29 Version 1.10.00
2003/12/14 Version 1.10.01
2003/12/23 Version 1.10.01a
2004/01/24 Version 1.11.00(β)
2004/04/17 Version 1.11.00
2004/12/22 Version 1.12.00
2004/12/31 Version 1.13.00
2005/01/03 Version 1.13.00a
2005/01/04 Version 1.14.00
2005/01/10 Version 1.14.01
2005/01/10 Version 1.15.00
2005/01/16 Version 1.15.01
2005/04/30 Version 1.16.00
2005/09/06 Version 1.16.01
2005/09/07 Version 1.16.01a
2005/09/09 Version 1.16.02
2005/09/10 Version 1.16.03
2005/09/17 Version 1.16.04
2005/09/19 Version 1.17.00
2005/09/22 Version 1.17.00a
2006/01/22 Version 1.18.00 β1
2006/03/21 Version 1.18.00正式版
2006/05/05 Version 1.18.01
2007/07/16 Version 1.19.00β1
2007/08/11 Version 1.19.00β2
2007/10/21 Version 1.19.00β3
2007/10/27 Version 1.19.00β4
2008/01/16 Version 1.19.00β5
2008/01/20 Version 1.19.00β6
2008/09/01 Version 1.19.00β7
2009/12/31 Version 1.19.00(正式版)
2010/04/03 Version 1.20.00β1
2010/10/24 Version 1.20.00β2
2013/02/03 Version 1.20.00β3
2013/03/03 Version 1.20.00β4
2013/05/06 Version 1.20.00(正式版)
2013/05/28 Version 1.20.00a(正式版)
2013/06/23 Version 1.21.00(正式版)
2013/10/29 Version 1.22.00β1
2014/05/03 Version 1.22.00β2
2014/09/28 Version 1.22.00β3
2014/10/18 Version 1.22.00(正式版)
2015/11/14 Version 1.23.00β1
2015/11/22 Version 1.23.00β2
2016/03/19 Version 1.23.00β3
2016/07/26 Version 1.23.00(正式版)
2016/07/30 Version 1.23.00a(正式版)
2016/08/01 Version 1.23.00b(正式版)
2016/11/03 Version 1.24.00β1
2017/04/21 Version 1.24.00β2
2017/05/05 Version 1.24.00β3

page top

その他・免責事項

謝 辞

以上の皆さんに感謝します。

page top

著作権・配布規定等

page top

EditorConfig C Core のライセンス

Unless otherwise stated, all files are distributed under the Simplified BSD
license. The inih(`src/lib/ini.c` and `src/lib/ini.h`) library is distributed
under the New BSD license. `src/lib/utarray.h` is distributed under the Revised
BSD License. The See LICENSE file for details. Some code in src/lib/misc.c is
idstributed under their own license (see the source file for details).

Copyright (c) 2011-2013 EditorConfig Team, including Hong Xu and Trey Hunner
Copyright (c) 2014 Hong Xu <hong AT topbug DOT net>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

PCRE のライセンス

PCRE LICENCE
------------

PCRE is a library of functions to support regular expressions whose syntax
and semantics are as close as possible to those of the Perl 5 language.

Release 8 of PCRE is distributed under the terms of the "BSD" licence, as
specified below. The documentation for PCRE, supplied in the "doc"
directory, is distributed under the same terms as the software itself. The data
in the testdata directory is not copyrighted and is in the public domain.

The basic library functions are written in C and are freestanding. Also
included in the distribution is a set of C++ wrapper functions, and a
just-in-time compiler that can be used to optimize pattern matching. These
are both optional features that can be omitted when the library is built.


THE BASIC LIBRARY FUNCTIONS
---------------------------

Written by:       Philip Hazel
Email local part: ph10
Email domain:     cam.ac.uk

University of Cambridge Computing Service,
Cambridge, England.

Copyright (c) 1997-2016 University of Cambridge
All rights reserved.


PCRE JUST-IN-TIME COMPILATION SUPPORT
-------------------------------------

Written by:       Zoltan Herczeg
Email local part: hzmester
Emain domain:     freemail.hu

Copyright(c) 2010-2016 Zoltan Herczeg
All rights reserved.


STACK-LESS JUST-IN-TIME COMPILER
--------------------------------

Written by:       Zoltan Herczeg
Email local part: hzmester
Emain domain:     freemail.hu

Copyright(c) 2009-2016 Zoltan Herczeg
All rights reserved.


THE C++ WRAPPER FUNCTIONS
-------------------------

Contributed by:   Google Inc.

Copyright (c) 2007-2012, Google Inc.
All rights reserved.


THE "BSD" LICENCE
-----------------

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

    * Neither the name of the University of Cambridge nor the name of Google
      Inc. nor the names of their contributors may be used to endorse or
      promote products derived from this software without specific prior
      written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

End

page top