DTO を使用した Zen サーバーの設定 : DtoSetting オブジェクト
 
このページをシェアする                  
DtoSetting オブジェクト
このオブジェクトは、環境設定を表します。
プロパティ
AllPossibleSelections
設定タイプが単一選択または複数選択であるとき、選択可能なすべての項目を表す DtoSelectionItems コレクションまたは DtoSelectionItem オブジェクトを返します。
このプロパティは、Type プロパティの設定が "dtoSingleSelection" または "dtoMultiSelection" の場合にのみ有効です。これらはそれぞれ、TypeNames プロパティの "Single Selection" および "Multiple Selection" に相当します。
Category
この設定に関連する DtoCategory オブジェクトを返します。
DefaultValue
設定のデフォルト値を返します。
戻り値は Type プロパティの設定に基づくバリアントです。
Type プロパティが "Single selection" の場合は DtoSelectionItem オブジェクトを返します。
Type プロパティが "Multiple selection" の場合は DtoSelectionItems コレクションを返します。
Factor
設定のファクター値を返します。
たとえば、多くの設定が Zen ではバイト単位で保存されていますが、ユーザーは設定を変更するときに値をキロバイトで入力する場合があります。
ある設定の Value プロパティで 16384 が返され、Factor プロパティが 1024 を返した場合、プログラムでは 16384 を 1024 で除算してユーザーに 16 を返します。その後、FactorString プロパティを照会し、新しい単位を取得します。この場合はキロバイトになります。
Value プロパティを設定する前に、Factor プロパティでユーザーが指定した値を乗算する必要があります。
FactorString
Factor プロパティに調整する Value プロパティの単位を返します。たとえば、UnitString プロパティが "byte(s)" を返した場合、FactorString プロパティは "kbyte(s)" を返し、Factor プロパティは "1024" を返します。
FalseString
ブール型の設定に対して False 値を返します。
このプロパティは、ブール型の設定の場合にのみ有効です。Type プロパティを使用して、設定がブール型かどうかを調べます。
Help
ある設定に関連するヘルプ テキストを返します。
IsClient
その設定が Zen クライアントに対して有効、あるいは Enterprise Server に対して有効かどうかを示すブール値を返します。
True = クライアント
False = サーバー
Max
Long 型の設定の最大値を返します。
このプロパティは、Long 型の設定の場合にのみ有効です。Type プロパティを使用して、設定が Long 型かどうかを調べます。
このプロパティで負数が返される場合、以下のように解釈されます。
/* 最大有効メモリまたはディスク サイズ */P_MAX_MEM_DISK_SIZE -129
/* 使用可能なディスク スペースによって制限される最大サイズ */P_MAX_LIMITED_BY_DISK -2
/* 使用可能なメモリによって制限される最大サイズ */P_MAX_LIMITED_BY_MEMORY -1
Min
Long 型の設定の最小値を返します。
このプロパティは、Long 型の設定の場合にのみ有効です。Type プロパティを使用して、設定が Long 型かどうかを調べます。
このプロパティは、有効でない場合 -1 が返されます。
Name
設定の名前を返します。
Rank
設定のランクを返します。ランクのグループ設定は、上級ユーザーにのみ適用するかどうかを条件とします。
0 = 標準
1 = 上級
Session
このオブジェクトに関連するセッションを返します。
SettingID
設定の固有の識別子を返します。
TrueString
ブール型の設定に対して True 値を返します。
このプロパティは、ブール型の設定の場合にのみ有効です。Type プロパティを使用して、設定がブール型かどうかを調べます。
Type
設定タイプ(設定タイプ列挙)を返します。
0 = Boolean(ブール型)
1 = Long(Long 型)
2 = String(文字列)
3 = Single selection(単一選択)
4 = Multiple selection(複数選択)
TypeName
設定のタイプを以下の文字列で返します。
Boolean
Long
String
Single selection
Multiple selection
UnitString
Long 型の設定の単位を返します。
たとえば、seconds、bytes などです。
ユーザーがより使いやすい値の範囲を利用できるよう Value プロパティを調整する場合は、Factor プロパティと FactorString プロパティを使用します。
Value
設定の値を取得または設定します。
戻り値は Type プロパティの設定に基づくバリアントです。
Type プロパティが "Single selection" の場合は DtoSelectionItem オブジェクトを返します。
Type プロパティが "Multiple selection" の場合は DtoSelectionItems コレクションを返します。
Long 型の設定に対してこのプロパティを設定する場合は、Min および Max プロパティで照会して、設定する値がその設定の制限範囲内であるかどうかをチェックしてください。
コレクション
DtoSelectionItems コレクション
メソッド
なし
備考
Type プロパティを使用して設定のタイプを見つけます。 次のタイプによって異なることに注意してください。
TrueString および FalseString プロパティはブール型の設定(0)にのみ適用されます。
FactorFactorStringMaxMin および UnitString プロパティは Long 型の設定(1)にのみ適用されます。
Set my_settings = my_category.Settings
Set first_setting = my_settings(1)
関連項目
DtoCategories コレクション
DtoCategory オブジェクト