Sakura-Editor Macro Reference

S_ExpandParameter

機能
特殊文字の展開
構文
string S_ExpandParameter ( S1 )  使用例

引数内容
S1文字列フォーマット文字列
設定値
引数 S1 の設定値は次のとおりです。

内容
$$ 文字 $ 自身
$F 開いているファイルの名前(フルパス)
$f 開いているファイルの名前(ファイル名+拡張子のみ)
$g 開いているファイルの名前(拡張子を除くファイル名のみ)
$/ 開いているファイルの名前(フルパス。パスの区切りが / )
$N 開いているファイルの名前(「共通設定⇒ファイル名表示」の設定で置換された表記)
$S サクラエディタ本体のフルパス
$M 実行中のマクロファイルのフルパス
$C 選択中のテキストまたはカーソル位置の単語
$x 現在の物理桁位置(先頭からのバイト数)(1開始)
$y 現在の物理行位置(1開始)
$d 現在の日付(共通設定の日付書式)
$t 現在の時刻(共通設定の時刻書式)
$D 開いているファイルのタイムスタンプ(共通設定の日付書式)
$T 開いているファイルのタイムスタンプ(共通設定の時刻書式)
$V サクラエディタのバージョン
$h Grep検索キーの先頭32byteまで
説明
フォーマット文字列に従った文字列を取得する。フォーマット文字列中の $ で始まる文字が特定の情報文字列に置き換わる。
条件文
フォーマット文字列中に条件文を記述することも可能である。条件文は入れ子に記述する事も出来る。

条件文書式:${c?A0$:A1$:A2$:...$}
条件 c に対応して A0,A1,A2 ... のいずれかの文字列が返される。条件 c として用意されている物は以下の通り。
条件動作
Rエディタ上で読み取り専用で開いている $: 上書き禁止のファイル $: いずれでもない
wGrep検索結果ウィンドウ $: アウトプットウィンドウ $: 普通のウィンドウ
Mキーボードマクロ記録中 $: 記録中ではない
U更新されている $: 更新されていない
Iエディタウィンドウがアクティブではない $: エディタウィンドウがアクティブ
読み取り専用
メニューで ファイル(F) → ファイル操作(R) → 読み取り専用(O) の操作
上書き禁止
ファイルの読み取り専用属性がON,他のアプリケーションが排他で開いている
補足
新規ファイル,Grep検索結果ウィンドウ,アウトプットウィンドウの場合、$F,$f,$g,$/ は「(無題)」に、$D,$T は「(保存されていません)」になる。
次の2つは同じ結果になる

$C は「検索ダイアログを出した時に、検索の“条件”欄に取り込まれる文字列」と同じ文字列になる。つまり次のような仕様である。

次の2つは同じ結果とは限らない
関連項目
S_GetSelectedString() S_GetFilename() S_About()