Syuhitu Home > 関連情報・ソフトウェア > プラグイン > API > PFID_GETCONFIGVALUE

PFID_GETCONFIGVALUE

 プラグイン設定ファイルに記述された設定情報を取得する

const wchar_t* (*PFT_GetConfigValue)(
	const wchar_t* pKey
);

概要

 プラグイン設定ファイルに記述された設定情報を参照します。 参照可能な値は、呼び出されたプラグインについて記述しているセクションに属する値のみです。

 たとえば、プラグイン設定ファイルに下記のように記述されていて、

[MyPlugin1]
PluginName = MyPlugin1
LibraryName = libmyplugin.so
FunctionName = foo
MenuLabel = プラグイン1
ConfigValue1 = あいうえお

[MyPlugin2]
PluginName = MyPlugin2
LibraryName = libmyplugin.so
FunctionName = foo
MenuLabel = プラグイン2
ConfigValue2 = かきくけこ

 ユーザが「プラグイン1」を選択した時に、 キーとして”ConfigValue1”を指定してこの関数を呼び出した場合は、「あいうえお」の値が返ってきます。 また、キーに”ConfigValue2”を指定した場合にはNULLが返ってきます。 この例のように、呼び出しているライブラリと関数が同じであっても、別のセクションの値を参照することはできません。

引数

pKey

 値を検索するためのキーを指定します。

戻り値

 値の取得に成功した場合は、そのアドレスが返されます。そうでない場合はNULLが返されます。 なお、返される値は内部で保持している値のアドレスなので、プラグイン側では解放しないでください。


Copyright(C) 2005 nabiki_t All Rights Reserved.