DTO を使用した Zen サーバーの設定

カテゴリの設定リストを取得するには、Settings プロパティを使って DtoSettings コレクションを返します。その後、その中に含まれる DtoSetting オブジェクトを使って特定の設定に関する情報を取得することができます。

備考

例

Dim category as DtoCategory

Dim my_categories as DtoCategories

Dim settings as DtoSettings

result = my_session.Connect("myserver", "username", "password")

'Categories コレクションを取得する

Set my_categories = my_session.Categories

' コレクション内をループする

For Each category In my_categories

Set settings = category.Settings

関連項目

DtoCategories コレクション

DtoSession オブジェクト

DtoLicenseMgr オブジェクト

DTO2 のみ：このオブジェクトを使用すれば、製品ライセンスの認証と認証解除、ライセンス検証操作の開始、および製品情報の XML 文字列の取得が行えます。

プロパティ

コレクション

メソッド

備考

Session オブジェクトから取得します。

例

result = my_session.Connect("myserver", "username", "password")

result = my_licmgr.AddLicense("ERXVD3U4ZS9KR94QPDHV5BN2")

'ライセンスを追加する

関連項目

DtoSession オブジェクト

メソッドの詳細

AddLicense

ライセンスを認証します。

構文

result = LicenseManager.AddLicense(License)

引数

LicenseManager	DtoLicenseMgr オブジェクト
License	DtoSession オブジェクトを使って現在接続しているエンジンに対して認証する、有効なライセンスキー。

戻り値

メソッド呼び出しの結果を示す DtoResult（Long 型の値）。DtoSession オブジェクトの Error プロパティを使って結果の説明を取得します。

例

result = my_session.Connect("myserver", "username", "password")

result = my_licmgr.AddLicense("ERXVD3U4ZS9KR94QPDHV5BN2")

'ライセンスを追加する

DeleteLicense

ライセンスを認証解除します。

構文

result = LicenseManager.DeleteLicense(License)

引数

LicenseManager	DtoLicenseMgr オブジェクト
License	DtoSession オブジェクトを使って現在接続しているエンジンから認証解除する、有効なライセンスキー。

戻り値

メソッド呼び出しの結果を示す DtoResult（Long 型の値）。DtoSession オブジェクトの Error プロパティを使って結果の説明を取得します。

備考

例

result = my_session.Connect("myserver", "username", "password")

result = my_licmgr.DeleteLicense("ERXVD3U4ZS9KR94QPDHV5BN2")

'ライセンスを削除する

GetProductInfo

License Manager で検出されたすべての Zen 製品の一覧を取得します。

構文

result = LicenseManager.GetProductInfo

引数

LicenseManager

DtoLicenseMgr オブジェクト

戻り値

製品の一覧を XML 形式の文字列で返します。

備考

XML 形式の文字列の詳細については、『Distributed Tuning Interface Guide』で PvGetProductsInfo() の備考を参照してください。

例

Dim session As New DtoSession

Set session = New DtoSession

Dim result As dtoResult

result = session.Connect("server", "user", "password")

If result <> Dto_Success Then

MsgBox "Error on connect."& CStr(result)

Exit Sub

End If

Dim xmlstring As String

xmlstring = session.LicenseMgr.GetProductInfo

RichTextBox1.TextRTF = xmlstring

ValidateLicenses

セッション接続によって示されるコンピューターのすべてのキーに関する有効性のチェックを開始します。

構文

result = LicenseManager.ValidateLicenses

引数

LicenseManager

DtoLicenseMgr オブジェクト

戻り値

メソッド呼び出しの結果を示す DtoResult（Long 型の値）。DtoSession オブジェクトの Error プロパティを使って結果の説明を取得します。

備考

ValidateLicenses は、検証チェックの要求から生じた結果のみを返します。キーの状態に関する情報は何も返しません。キーの状態に関する情報も含め、製品情報の XML 文字列を取得するには、別に GetProductInfo を呼び出す必要があります。

例

result = my_session.Connect("myserver", "username", "password")

result = my_licmgr.ValidateLicenses

'すべてのキーの検証チェックを開始する

DtoSettings コレクション

このコレクションには、特定の DtoCategory オブジェクトのすべての設定を表す DtoSetting オブジェクトが含まれます。

プロパティ

Count	コレクション内のメンバー数を返します。
Item	コレクションの特定のメンバーを返します。

メソッド

Count プロパティを使用してコレクション内のメンバー数を調べます。

備考

このコレクションでは、1 から始まる序数または設定名を含むバリアントを渡して個別の項目を取得することができます。

メモ：また、DtoSession オブジェクトの GetSetting を使って個別の設定を取得することもできます。これにより、カテゴリと設定内のループを節約します。

例

Dim my_categories as DtoCategories

Set my_categories = my_session.Categories

Dim my_settings as DtoSettings

Dim first_setting as DtoSetting

Set my_settings = my_categories.Settings

Set first_setting = my_settings(1)

関連項目

プロパティ

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 プロパティが "bytes" を返した場合、FactorString プロパティは "kbytes" を返し、Factor プロパティは "1024" を返します。
FalseString	ブール型の設定の False 値を返します。このプロパティは、ブール型の設定の場合にのみ有効です。設定がブール型かどうかを調べるには、Type プロパティを使用します。
Help	ある設定に関連するヘルプテキストを返します。
IsClient	その設定が Zen クライアントに対して有効か、または Enterprise Server に対して有効かどうかを示すブール値を返します。 True = クライアント False = サーバー
Max	Long 型の設定の最大値を返します。このプロパティは、Long 型の設定の場合にのみ有効です。設定が Long 型かどうかを調べるには、Type プロパティを使用します。このプロパティで負数が返される場合、以下のように解釈されます。 /* 最大有効メモリまたはディスクサイズ /P_MAX_MEM_DISK_SIZE -129 / 使用可能なディスクスペースによって制限される最大サイズ /P_MAX_LIMITED_BY_DISK -2 / 使用可能なメモリによって制限される最大サイズ */P_MAX_LIMITED_BY_MEMORY -1
Min	Long 型の設定の最小値を返します。このプロパティは、Long 型の設定の場合にのみ有効です。設定が Long 型かどうかを調べるには、Type プロパティを使用します。このプロパティが有効でない場合は -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）にのみ適用されます。

•

Factor、FactorString、Max、Min および UnitString プロパティは Long 型の設定（1）にのみ適用されます。

例

Set my_settings = my_category.Settings

Set first_setting = my_settings(1)

関連項目

DtoCategories コレクション

DtoCategory オブジェクト

DtoSelectionItems コレクション

選択タイプの設定で、選択可能な値を表す DtoSelectionItem オブジェクトのコレクション。

プロパティ

Count	コレクション内のメンバー数を返します。
Item	コレクションの特定のメンバーを返します。

メソッド

Add

GetById

Remove

備考

DtoSetting オブジェクトの AllPossibleSelections プロパティは、DtoSelectionItems コレクションを返します。

Count プロパティを使用してコレクション内のメンバー数を調べます。

例

Set first_setting = my_settings(1)

type = first_setting.Type

'選択タイプの設定の場合のみこれを呼び出す

'設定タイプの一覧は、設定タイプ列挙を参照

if (type = dtoSingleSel) OR (type = dtoMultiSel)

Set all_the_selections = first_setting.AllPossibleSelections

関連項目

DtoCategories コレクション

DtoSetting オブジェクト

メソッドの詳細

Add

DtoSelectionItems コレクションに項目を追加します。

構文

result = Collection.Add(Object)

引数

Collection	オブジェクトを追加する DtoSelectionItems コレクション。
Object	追加する DtoSelectionItem オブジェクト。

戻り値

このメソッドには DtoSelectionItem タイプのパラメーターが必要です。このため、コレクションにオブジェクトを追加する前に、まずオブジェクトのインスタンスを作成してそのプロパティを設定する必要があります。

メソッド呼び出しの結果を示す DtoResult（Long 型の値）。DtoSession オブジェクトの Error プロパティを使って結果の説明を取得します。

備考

例

Dim Result As dtoResult

Dim Session As New DtoSession

Result = Session.Connect("nik-ntws", "", "")

Dim my_setting As DtoSetting

Dim SetID As Long

SetID = 26

Set my_setting = Session.GetSetting(SetID)

If my_setting Is Nothing Then

MsgBox " Setting is wrong"

new_selections.Add my_setting.AllPossibleSelections.Item(1)

'TCP

my_setting.Value = new_selections

GetById

指定した ID で DtoSelectionItems コレクションから DtoSelectionItem オブジェクトを返します。

構文

my_selection_item = Collection.GetById(id)

引数

Collection	DtoSelectionItems コレクション
id	コレクションから取得する項目の ID。特定の選択項目の ID は DtoSelectionItem オブジェクトの ItemId プロパティを使って取得することができます。

戻り値

my_selection_item

id に相当する DtoSelectionItem オブジェクト

例

Dim Result As DtoResult

Dim Session As New DtoSession

Result = Session.Connect("nik-ntws", "", "")

Dim my_setting As DtoSetting

Dim SetID As Long

SetID = 26

Set my_setting = Session.GetSetting(SetID)

If my_setting Is Nothing Then

MsgBox " Setting is wrong"

Exit Sub

End If

Dim new_selections As New DtoSelectionItems

new_selections.Add my_setting.AllPossibleSelections.GetByID(3) 'Microsoft TCP/IP

my_setting.Value = new_selections

Remove

DtoSelectionItems コレクションから項目を削除します。

構文

result = Collection.Remove(item)

引数

Collection	DtoSelectionItems コレクション
item	コレクションから削除する項目の（1 から始まる）インデックスまたは選択項目の名前を含むバリアント。

戻り値

このメソッドには DtoSelectionItem タイプのパラメーターが必要です。

メソッド呼び出しの結果を示す DtoResult（Long 型の値）。DtoSession オブジェクトの Error プロパティを使って結果の説明を取得します。

備考

例

Dim Result As DtoResult

Dim Session As New DtoSession

Result = Session.Connect("nik-ntws", "", "")

Dim my_setting As DtoSetting

Dim SetID As Long

SetID = 26

Set my_setting = Session.GetSetting(SetID)

If my_setting Is Nothing Then

MsgBox " Setting is wrong"

Exit Sub

End If

Dim new_selections As New DtoSelectionItems

new_selections.Add my_setting.AllPossibleSelections.GetByID(3) ''Microsoft TCP/IP

new_selections.Remove(1)

my_setting.Value = new_selections

DtoSelectionItem オブジェクト

選択タイプの設定で選択可能な値を表すオブジェクトです。

プロパティ

ItemID	選択項目の一意の ID を返します。
Setting	この選択項目を適用する設定を返します。
String	選択項目の値を返します。

メソッド