getspecialfolder

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

getspecialfolder 機能

[その他のコマンド]

特殊フォルダのパスを取得します。

コマンドライン

getspecialfolder <strvar> <foldertype>

機能説明

Windows の特殊フォルダを取得して <strvar> に格納します。
<strvar>
取得された文字列が格納されます。
<foldertype>
この引数で指定した種類の特殊フォルダが文字列変数 <strvar>に代入されます。
特殊フォルダ対象フォルダ
AllUsersDesktopAll Usersの「デスクトップ」フォルダ
AllUsersStartMenuAll Usersの「スタートメニュー」フォルダ
AllUsersProgramsAll Usersのスタートメニューの「プログラム」フォルダ
AllUsersStartupAll Usersのスタートメニューの「スタートアップ」フォルダ
Desktop「デスクトップ」仮想フォルダ
Favorites「お気に入り」フォルダ
Fonts「フォント」仮想フォルダ
MyDocuments「マイ ドキュメント」仮想フォルダ
NetHood「マイネットワーク」仮想フォルダ
PrintHood「プリンタ」仮想フォルダ
Programsスタートメニューの「プログラム」フォルダ
Recent「最近使ったファイル」フォルダ
SendToコンテキストメニューの「送る」フォルダ
StartMenu「スタートメニュー」フォルダ
Startupスタートメニューの「スタートアップ」フォルダ
Templates「テンプレート」フォルダ

パラメータの説明

指定するパラメータは以下の通りです。
パラメータパラメータ説明
<strvar>文字列指定した取得フォルダを格納する変数を指定します。
<foldertype>文字列特殊フォルダを指定します。

対象バージョン

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

戻り値

戻り値として以下の変数が定義されます。
変数名意味
result0取得に失敗した
1取得に成功した
<strvar>文字列取得された文字列
<strvar> は、コマンド実行時に指定した任意の文字列です。

関連コマンド

関連コマンドはありません。

使用方法

使用例

・取得したデスクトップのパスを表示する場合
getspecialfolder str "Desktop"
if result then
	messagebox str "Desktop"   ; C:\Documents and Settings\user\desktop
endif

サンプル

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

備考

cf. CSIDL(MSDN library)