製品マニュアル

アプリケーションのプロパティ

このカテゴリの API は、アプリケーションのプロパティを定義して取得するために使用します。

説明: このインターフェースを使用して、アプリケーションタイプオブジェクトの事前定義プロパティを設定します。アプリケーションタイプオブジェクトは、アプリケーションインスタンス、アプリケーションユニットおよびアプリケーションファイルです。

カスタムまたはユーザー定義のプロパティを設定する場合、set_custom_property API を使用します。

次の表に、アプリケーションインスタンス、ユニット、およびファイルのプロパティをリストします。

必須: いいえ

入力パラメータ: 文字列: 属性名および属性値

戻り値: 成功した場合は 0、それ以外の場合は正の数です。

例:

Application instance:
my $inst = $appObj->add_application_inst("app_inst");
if (defined $inst)
{
		$inst->set_property("FRIENDLY_NAME", "MyAppInstance");
}

Application unit:
my $inst = $appObj->add_application_inst("app_inst");
if (defined $inst)
{
		my $unit = $inst->add_application_unit("app_unit");
		$unit->set_property("OWNER", "MyOwner");
}

Application file:
my $inst = $appObj->add_application_inst("app_inst");
if (defined $inst)
{
my $file = $inst->add_application_file("master.data");
$file->set_property("SIZE", "100");
}

説明: このインターフェースを使用して、任意のカスタムプロパティを定義します。

アプリケーションインスタンス、アプリケーションユニット、およびアプリケーションファイルのカスタムの定義済みプロパティを設定するのに、このインターフェースを使用できます。

必須: いいえ

入力パラメータ: 文字列: 属性名、属性値、is_secure (true または false)、および属性のタイプ。属性の is_secure とタイプは省略可能です。is_secure が true に設定されている場合は、プロパティの値は暗号化されます。

戻り値: プロパティが正常に追加された場合は 0、それ以外の場合は任意の正の数。

例:

Application instance:
my $inst = $appObj->add_application_inst("app_inst");
if (defined $inst)
{
		$inst->set_custom_property("HOMEDIR", "MyDir");
}

Application unit:
my $inst = $appObj->add_application_inst("app_inst");
if (defined $inst)
{
		my $unit = $inst->add_application_unit("app_unit");
		$unit->set_custom_property("USER", "MyUser");
}

Application file:
my $inst = $appObj->add_application_inst("app_inst");
if (defined $inst)
{
my $file = $inst->add_application_file("master.data");
$file->set_custom_property("CHECKSUM", "123456789");
}