TamKeyTable構造体 【TP1/Server Base】

名前空間

Hitachi.OpenTP1.Server

継承関係

System.Object
  +- System.ValueType
    +- Hitachi.OpenTP1.Server.TamKeyTable

説明

TamKeyTable構造体は，レコードのキー値を格納します。

KeyNameプロパティ，KeyName2プロパティのどちらでもキー値を設定できますが，設定しない方のプロパティをnull（Visual Basicの場合はNothing）にしてください。両方にキー値を設定した場合は，KeyNameプロパティのキー値を有効なキー値とします。

TamKeyTable構造体配列にした場合，各要素のプロパティはTamKeyTable構造体配列の先頭のTamKeyTable構造体のプロパティと同一の型のプロパティを使用してください。

プロパティの一覧

●KeyName

説明

string型でキー値を設定します。

宣言

【C#の場合】

public string KeyName {get; set;}

【Visual Basicの場合】

Public Property KeyName As String

【J#の場合】

public System.String get_KeyName();
public void set_KeyName(System.String);

例外

なし

注意事項

KeyNameプロパティに設定した文字列はANSI文字列（マルチバイト文字列）に変換されます。変換後の文字列の長さがtamcreコマンドの-lオプションで設定したキー領域長と一致するようにしてください。変換後の文字列の長さがキー領域長より短い場合は，変換後の文字列の後ろに不正な値が付加され，不正な文字列になります。変換後の文字列の長さがキー領域長より長い場合は，キー値として有効な文字列はキー領域長分になります。

●KeyName2

説明

byte配列型でキー値を設定します。

宣言

【C#の場合】

public byte[] KeyName2 {get; set;}

【Visual Basicの場合】

Public Property KeyName2() As Byte

【J#の場合】

public ubyte[] get_KeyName2();
public void set_KeyName2(ubyte[]);

例外

なし

注意事項

• KeyName2プロパティに設定したバイト配列の長さがtamcreコマンドの-lオプションで設定したキー領域長と一致するようにしてください。バイト配列の長さがキー領域長より短い場合は，設定したバイナリデータの後ろに不正な値が付加され，不正なバイナリデータになります。バイト配列の長さがキー領域長より長い場合は，キー値として有効なバイナリデータはキー領域長分になります。

• KeyName2プロパティを使用する場合は，TamKeyTable構造体配列で指定したすべてのKeyName2プロパティに値を指定してください。null（Visual Basicの場合はNothing）または長さが0のバイト配列がある場合は，例外TP1Error.DCTAMER_PARAM_KEYが返ります。

• KeyName2プロパティを使用する場合は，TamKeyTable構造体配列で指定したすべてのKeyName2プロパティの長さの総和が2147483647バイト以下になるようにしてください。2147483647バイトより長い場合は，例外TP1Error.DCTAMER_PARAM_KEYが返ります。