プロパティ
All
プロパティマップのRootカテゴリから到達可能なすべてのプロパティを列挙します。
宣言
public IEnumerable<Property> All { get; }
this[string]
指定された名前のプロパティを返します。
宣言
public Property this[string propName] { get; }
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
返すプロパティの名前 |
プロパティ値
備考
これはFind(string)を呼び出すショートカットです。
このプロパティマップに指定された名前のプロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(string, out Property)を使用してください。
this[PropIdBoolean]
指定された識別子のブールプロパティを返します。
宣言
public PropBoolean this[PropIdBoolean booleanId] { get; }
プロパティ値
備考
これはFind(PropIdBoolean)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致するブールプロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdBoolean, out PropBoolean)を使用してください。
this[PropIdCommand]
指定された識別子のコマンドプロパティを返します。
宣言
public PropCommand this[PropIdCommand commandId] { get; }
プロパティ値
備考
これはFind(PropIdCommand)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致するコマンドプロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdCommand, out PropCommand)を使用してください。
this[PropIdEnumeration]
指定された識別子の列挙プロパティを返します。
宣言
public PropEnumeration this[PropIdEnumeration enumerationId] { get; }
プロパティ値
備考
これはFind(PropIdEnumeration)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致する列挙プロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdEnumeration, out PropEnumeration)を使用してください。
this[PropIdFloat]
指定された識別子の浮動小数点プロパティを返します。
宣言
public PropFloat this[PropIdFloat floatId] { get; }
プロパティ値
備考
これはFind(PropIdFloat)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致する浮動小数点プロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdFloat, out PropFloat)を使用してください。
this[PropIdInteger]
指定された識別子の整数プロパティを返します。
宣言
public PropInteger this[PropIdInteger integerId] { get; }
プロパティ値
備考
これはFind(PropIdInteger)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致する整数プロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdInteger, out PropInteger)を使用してください。
this[PropIdRegister]
指定された識別子のレジスタプロパティを返します。
宣言
public PropRegister this[PropIdRegister registerId] { get; }
プロパティ値
備考
これはFind(PropIdRegister)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致するレジスタプロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdRegister, out PropRegister)を使用してください。
this[PropIdString]
指定された識別子の文字列プロパティを返します。
宣言
public PropString this[PropIdString stringId] { get; }
プロパティ値
備考
これはFind(PropIdString)を呼び出すショートカットです。
このプロパティマップに指定された識別子と一致する文字列プロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdString, out PropString)を使用してください。
メソッド
ConnectChunkData(ImageBuffer)
渡されたImageBuffer内のチャンクデータを、プロパティマップのチャンクプロパティ用バックエンドとして使用できるようにします。
宣言
public void ConnectChunkData(ImageBuffer buffer)
パラメータ
| 型 |
名前 |
説明 |
| ImageBuffer |
buffer |
チャンクデータを含む画像バッファ。このパラメータにnullを指定すると、以前接続していたバッファの接続を解除します。 |
備考
プロパティマップは渡された画像バッファへの参照を保持し、そのライフタイムを延長して自動再利用を防ぎます。
この参照は、新しい画像バッファがプロパティマップに接続されたとき、またはbuffer引数にnullが渡されたときに解放されます。
DeSerialize(byte[])
このプロパティマップのプロパティ状態を、以前Serialize()で書き込まれたデータを含むメモリバッファから復元します。
宣言
public void DeSerialize(byte[] data)
パラメータ
| 型 |
名前 |
説明 |
| byte[] |
data |
シリアライズされたプロパティデータを含むバイト配列 |
DeSerialize(Stream)
このプロパティマップのプロパティ状態を、以前Serialize(Stream)で書き込まれたストリームから復元します。
宣言
public void DeSerialize(Stream strm)
パラメータ
| 型 |
名前 |
説明 |
| Stream |
strm |
シリアライズされたプロパティデータを含むストリーム |
DeSerialize(string)
このプロパティマップのプロパティ状態を、以前Serialize(string)で書き込まれたファイルから復元します。
宣言
public void DeSerialize(string fileName)
パラメータ
| 型 |
名前 |
説明 |
| string |
fileName |
シリアライズされたプロパティデータを含むファイルのパス |
ExecuteCommand(string)
既知の名前を持つコマンドを実行します。
宣言
public void ExecuteCommand(string commandName)
パラメータ
| 型 |
名前 |
説明 |
| string |
commandName |
このプロパティマップ内のコマンドの名前 |
ExecuteCommand(PropIdCommand)
指定された識別子を持つコマンドを実行します。
宣言
public void ExecuteCommand(PropIdCommand commandId)
Find(string)
指定された名前を持つプロパティを返します。
宣言
public Property Find(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得するプロパティの名前 |
備考
このプロパティマップに指定された名前のプロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFind(string, out Property) を使用してください。
Find(PropIdBoolean)
指定された識別子のブールプロパティを返します。
宣言
public PropBoolean Find(PropIdBoolean booleanId)
戻り値
備考
このプロパティマップに指定された識別子と一致するブールプロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdBoolean, out PropBoolean)を使用してください。
Find(PropIdCommand)
指定された識別子のコマンドプロパティを返します。
宣言
public PropCommand Find(PropIdCommand commandId)
戻り値
備考
このプロパティマップに指定された識別子と一致するコマンドプロパティが存在しない場合、IC4Exceptionが発生します。
プロパティが見つからなかった場合に例外を回避したい場合は、TryFind(PropIdCommand, out PropCommand)を使用してください。
Find(PropIdEnumeration)
指定された識別子を持つ列挙プロパティを返します。
宣言
public PropEnumeration Find(PropIdEnumeration enumerationId)
備考
このプロパティマップに指定された識別子の列挙プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFind(PropIdEnumeration, out PropEnumeration) を使用してください。
Find(PropIdFloat)
指定された識別子を持つ浮動小数点プロパティを返します。
宣言
public PropFloat Find(PropIdFloat floatId)
備考
このプロパティマップに指定された識別子の浮動小数点プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFind(PropIdFloat, out PropFloat) を使用してください。
Find(PropIdInteger)
指定された識別子を持つ整数プロパティを返します。
宣言
public PropInteger Find(PropIdInteger integerId)
備考
このプロパティマップに指定された識別子に一致する整数プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、
TryFind(PropIdInteger, out PropInteger)
を使用してください。
Find(PropIdRegister)
指定された識別子を持つレジスタプロパティを返します。
宣言
public PropRegister Find(PropIdRegister registerId)
備考
このプロパティマップに指定された識別子に一致するレジスタプロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、
TryFind(PropIdRegister, out PropRegister)を使用してください。
Find(PropIdString)
指定された識別子を持つ文字列プロパティを返します。
宣言
public PropString Find(PropIdString stringId)
戻り値
備考
このプロパティマップに指定された識別子に一致する文字列プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFind(PropIdString, out PropString) を使用してください。
FindBoolean(string)
指定された名前を持つブール型プロパティを返します。
宣言
public PropBoolean FindBoolean(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得するブール型プロパティの名前 |
備考
このプロパティマップに指定された名前のブール型プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindBoolean(string, out PropBoolean) を使用してください。
FindCategory(string)
指定された名前を持つカテゴリプロパティを返します。
宣言
public PropCategory FindCategory(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得するカテゴリプロパティの名前 |
備考
このプロパティマップに指定された名前のカテゴリプロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindCategory(string, out PropCategory) を使用してください。
FindCommand(string)
指定された名前を持つコマンドプロパティを返します。
宣言
public PropCommand FindCommand(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得するコマンドプロパティの名前 |
備考
このプロパティマップに指定された名前のコマンドプロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindCommand(string, out PropCommand) を使用してください。
FindEnumeration(string)
指定された名前を持つ列挙プロパティを返します。
宣言
public PropEnumeration FindEnumeration(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得する列挙プロパティの名前 |
備考
このプロパティマップに指定された名前の列挙プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindEnumeration(string, out PropEnumeration) を使用してください。
FindFloat(string)
指定された名前を持つ浮動小数点プロパティを返します。
宣言
public PropFloat FindFloat(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得する浮動小数点プロパティの名前 |
備考
このプロパティマップに指定された名前の浮動小数点プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindFloat(string, out PropFloat) を使用してください。
FindInteger(string)
指定された名前を持つ整数プロパティを返します。
宣言
public PropInteger FindInteger(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得する整数プロパティの名前 |
戻り値
備考
このプロパティマップに指定された名前を持つ整数プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindInteger(string, out PropInteger) を使用してください。
FindRegister(string)
指定された名前を持つレジスタプロパティを返します。
宣言
public PropRegister FindRegister(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得するレジスタプロパティの名前 |
戻り値
備考
このプロパティマップに指定された名前を持つレジスタプロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindRegister(string, out PropRegister) を使用してください。
FindString(string)
指定された名前を持つ文字列プロパティを返します。
宣言
public PropString FindString(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
取得する文字列プロパティの名前 |
戻り値
備考
このプロパティマップに指定された名前を持つ文字列プロパティが存在しない場合、IC4Exception がスローされます。
プロパティが見つからない場合に例外を発生させたくない場合は、TryFindString(string, out PropString) を使用してください。
GetValueBool(string)
指定された名前を持つプロパティの値を、bool として解釈して取得します。
宣言
public bool GetValueBool(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
戻り値
| 型 |
説明 |
| bool |
bool として解釈されたプロパティの値 |
GetValueBool(PropIdBoolean)
指定された識別子を持つブール型プロパティの値を取得します。
宣言
public bool GetValueBool(PropIdBoolean booleanId)
GetValueBool(PropIdEnumeration)
指定された識別子を持つ列挙型プロパティの値を、ブール値として取得します。
宣言
public bool GetValueBool(PropIdEnumeration enumerationId)
戻り値
| 型 |
説明 |
| bool |
列挙型プロパティの値をブール値として解釈した結果 |
備考
現在選択されているエントリの名前が、true または false を表していることが明確な場合に値が返されます。
GetValueDouble(string)
既知の名前を持つプロパティの値を double として取得します。
宣言
public double GetValueDouble(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
戻り値
| 型 |
説明 |
| double |
double として解釈されたプロパティの値 |
GetValueDouble(PropIdFloat)
特定の識別子を持つ float プロパティの値を取得します。
宣言
public double GetValueDouble(PropIdFloat floatId)
パラメータ
| 型 |
名前 |
説明 |
| PropIdFloat |
floatId |
このプロパティマップ内の float プロパティの識別子 |
GetValueDouble(PropIdInteger)
指定された識別子を持つ整数プロパティの値を double に変換して取得します。
宣言
public double GetValueDouble(PropIdInteger integerId)
戻り値
| 型 |
説明 |
| double |
整数プロパティの値を double に変換したもの |
GetValueLong(string)
既知の名前を持つプロパティの値を、整数として解釈して取得します。
宣言
public long GetValueLong(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
戻り値
| 型 |
説明 |
| long |
整数として解釈されたプロパティの値 |
GetValueLong(PropIdBoolean)
特定の識別子を持つブール型プロパティの値を、整数表現として取得します。
宣言
public long GetValueLong(PropIdBoolean booleanId)
戻り値
| 型 |
説明 |
| long |
プロパティの値が true の場合は 1、それ以外の場合は false |
GetValueLong(PropIdEnumeration)
渡された列挙型プロパティが PixelFormat の場合、現在選択されているピクセルフォーマットを取得します。
宣言
public PixelFormat GetValueLong(PropIdEnumeration enumerationId)
GetValueLong(PropIdInteger)
指定した識別子を持つ整数プロパティの値を取得します。
宣言
public long GetValueLong(PropIdInteger integerId)
GetValueString(string)
既知の名前を持つプロパティの値を、文字列として取得します。
宣言
public string GetValueString(string propName)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
戻り値
| 型 |
説明 |
| string |
文字列として解釈されたプロパティの値 |
備考
動作はプロパティの型によって異なります。
- 整数プロパティの場合、値は文字列に変換されます。
- 浮動小数点プロパティの場合、値は文字列に変換されます。
- ブール型プロパティの場合、戻り値は
"true" または "false" になります。
- 列挙型プロパティの場合、現在選択されているエントリ名が返されます。
- 文字列プロパティの場合、値はそのまま返されます。
- それ以外のプロパティ型の場合、呼び出しはエラーになります(IC4Exception がスローされ、ErrorCode は GenICamTypeMismatch に設定されます)。
GetValueString(PropIdBoolean)
指定された識別子を持つブール型プロパティの値を、文字列として返します。
宣言
public string GetValueString(PropIdBoolean booleanId)
GetValueString(PropIdEnumeration)
指定した識別子を持つ列挙型プロパティの値を、文字列として返します。
宣言
public string GetValueString(PropIdEnumeration enumerationId)
GetValueString(PropIdFloat)
指定した識別子を持つ浮動小数点プロパティの値を、文字列として返します。
宣言
public string GetValueString(PropIdFloat floatId)
戻り値
| 型 |
説明 |
| string |
浮動小数点プロパティの値を表す文字列 |
GetValueString(PropIdInteger)
指定した識別子を持つ整数プロパティの値を、文字列として返します。
宣言
public string GetValueString(PropIdInteger integerId)
GetValueString(PropIdString)
指定した識別子を持つ文字列プロパティの値を、文字列として返します。
宣言
public string GetValueString(PropIdString stringId)
Serialize()
このプロパティマップ内のプロパティ状態をメモリバッファに保存します。
宣言
public byte[] Serialize()
戻り値
| 型 |
説明 |
| byte[] |
シリアライズされたプロパティ状態を含むバイト配列 |
備考
後でプロパティの状態を復元するには、DeSerialize(byte[]) を使用してください。
Serialize(Stream)
このプロパティマップ内のプロパティ状態を Stream に保存します。
宣言
public void Serialize(Stream strm)
パラメータ
| 型 |
名前 |
説明 |
| Stream |
strm |
プロパティ状態を書き込むためのストリーム |
備考
後でプロパティの状態を復元するには、DeSerialize(Stream) を使用してください。
Serialize(string)
このプロパティマップ内のプロパティ状態をファイルに保存します。
宣言
public void Serialize(string fileName)
パラメータ
| 型 |
名前 |
説明 |
| string |
fileName |
プロパティ状態を書き込むファイルのパス |
備考
後でプロパティの状態を復元するには、DeSerialize(string) を使用してください。
SetValue(string, bool)
指定した名前のプロパティに、渡された bool 値を設定します。
宣言
public void SetValue(string propName, bool value)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
| bool |
value |
設定する新しい値 |
備考
動作はプロパティの型によって異なります。
- ブール型プロパティの場合、値はそのまま設定されます。
- 列挙型プロパティの場合、
true または false を表すと明確に判断できる名前のエントリが存在すれば、それが選択されます。
- コマンド型プロパティの場合、
value が true のときにコマンドが実行されます。
- それ以外のプロパティ型では、この呼び出しはエラーとなります。
SetValue(string, double)
指定した名前のプロパティに、渡された double 値を設定します。
宣言
public void SetValue(string propName, double value)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
| double |
value |
設定する新しい値 |
備考
動作はプロパティの型によって異なります。
- 整数型プロパティの場合、値は最も近い整数に丸められます。
- 浮動小数点型プロパティの場合、値はそのまま設定されます。
- それ以外のプロパティ型では、この呼び出しはエラーとなります。
SetValue(string, long)
指定した名前のプロパティに、渡された整数値を設定します。
宣言
public void SetValue(string propName, long value)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
| long |
value |
設定する新しい値 |
備考
動作はプロパティの型によって異なります。
- 整数型プロパティの場合、値はそのまま設定されます。
- 浮動小数点型プロパティの場合、値はそのまま設定されます。
- ブール型プロパティの場合、値が
1 または 0 のとき、それぞれ true または false に設定されます。それ以外の値はエラーとなります。
- 列挙型プロパティの場合、値はそのまま設定されます。
- コマンド型プロパティの場合、値が
1 のときにコマンドが実行されます。
- それ以外のプロパティ型では、この呼び出しはエラーとなります。
SetValue(string, string)
既知の名前を持つプロパティの値を、指定された文字列値に設定します。
宣言
public void SetValue(string propName, string value)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
このプロパティマップ内のプロパティ名 |
| string |
value |
設定する新しい値 |
備考
動作はプロパティの種類によって異なります。
- 整数型プロパティの場合、文字列を解析し、取得された整数値が設定されます。
- 浮動小数点型プロパティの場合、文字列を解析し、取得された浮動小数点値が設定されます。
- ブール型プロパティの場合、文字列が
true または false を明確に表すと判断できる場合に値が設定されます。
- 列挙型プロパティの場合、値に一致する名前を持つエントリが設定されます。
- 文字列型プロパティの場合、値がそのまま設定されます。
- コマンド型プロパティの場合、
value が "1"、"true"、または "execute" の場合にコマンドが実行されます。
- それ以外のプロパティ型では、この呼び出しはエラーになります。
SetValue(PropIdBoolean, bool)
指定された識別子を持つブール型プロパティの値を、指定された bool 値に設定します。
宣言
public void SetValue(PropIdBoolean boolId, bool value)
SetValue(PropIdBoolean, string)
指定された識別子を持つブール型プロパティの値を、指定された文字列値に設定します。
宣言
public void SetValue(PropIdBoolean boolId, string value)
パラメータ
備考
文字列が true または false を表すものとして一意に解釈できる場合に、その値が設定されます。
SetValue(PropIdEnumeration, bool)
指定された識別子を持つ列挙型プロパティにおいて、指定されたブール値に一致するエントリを選択します。
宣言
public void SetValue(PropIdEnumeration enumerationId, bool value)
パラメータ
備考
名前が true または false を表すものとして一意に解釈できるエントリが存在する場合にのみ、そのエントリが選択されます。
SetValue(PropIdEnumeration, string)
列挙プロパティの現在のエントリを名前または表示名で選択します。
宣言
public void SetValue(PropIdEnumeration enumerationId, string entryName)
SetValue(PropIdEnumeration, PixelFormat)
指定した識別子を持つ列挙型プロパティの現在のエントリを PixelFormat の値に設定します。
宣言
public void SetValue(PropIdEnumeration enumerationId, PixelFormat pixelFormat)
パラメータ
備考
ピクセルフォーマットを設定する際にキャストを行わずに済むよう、このオーバーロードが用意されています。
SetValue(PropIdFloat, double)
指定した識別子を持つ浮動小数点型プロパティの値を、渡された double 値に設定します。
宣言
public void SetValue(PropIdFloat floatId, double value)
SetValue(PropIdInteger, long)
指定した識別子を持つ整数型プロパティの値を、渡された整数値に設定します。
宣言
public void SetValue(PropIdInteger integerId, long value)
SetValue(PropIdString, string)
指定した識別子を持つ文字列型プロパティの値を、渡された文字列値に設定します。
宣言
public void SetValue(PropIdString stringId, string value)
TryFind(string, out Property)
このプロパティマップ内で、指定された名前のプロパティを検索します。
宣言
public bool TryFind(string propName, out Property prop)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
プロパティ名 |
| Property |
prop |
成功した場合にプロパティオブジェクトを受け取る出力パラメータ |
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外がスローされるのを避けるため、Find(string) の代わりにこの関数を使用してください。
TryFind(PropIdBoolean, out PropBoolean)
指定された識別子を持つブール型プロパティの検索を試みます。
宣言
public bool TryFind(PropIdBoolean booleanId, out PropBoolean prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdBoolean) の代わりにこの関数を使用してください。
TryFind(PropIdCommand, out PropCommand)
指定された識別子を持つコマンドプロパティの検索を試みます。
宣言
public bool TryFind(PropIdCommand commandId, out PropCommand prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdCommand) の代わりにこの関数を使用してください。
TryFind(PropIdEnumeration, out PropEnumeration)
指定された識別子を持つ列挙型プロパティの検索を試みます。
宣言
public bool TryFind(PropIdEnumeration enumerationId, out PropEnumeration prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdEnumeration) の代わりにこの関数を使用してください。
TryFind(PropIdFloat, out PropFloat)
指定された識別子を持つ浮動小数点型プロパティの検索を試みます。
宣言
public bool TryFind(PropIdFloat floatId, out PropFloat prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdFloat) の代わりにこの関数を使用してください。
TryFind(PropIdInteger, out PropInteger)
指定された識別子を持つ整数型プロパティの検索を試みます。
宣言
public bool TryFind(PropIdInteger integerId, out PropInteger prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdInteger) の代わりにこの関数を使用してください。
TryFind(PropIdRegister, out PropRegister)
指定された識別子を持つレジスタ型プロパティの検索を試みます。
宣言
public bool TryFind(PropIdRegister registerId, out PropRegister prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdRegister) の代わりにこの関数を使用してください。
TryFind(PropIdString, out PropString)
指定された識別子を持つ文字列型プロパティの検索を試みます。
宣言
public bool TryFind(PropIdString stringId, out PropString prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、Find(PropIdString) の代わりにこの関数を使用してください。
TryFindBoolean(string, out PropBoolean)
このプロパティマップ内で指定された名前のブール型プロパティの検索を試みます。
宣言
public bool TryFindBoolean(string propName, out PropBoolean prop)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
ブール型プロパティの名前 |
| PropBoolean |
prop |
成功時にブール型プロパティオブジェクトを受け取る出力パラメータ |
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindBoolean(string) の代わりにこの関数を使用してください。
TryFindCategory(string, out PropCategory)
このプロパティマップ内で指定された名前のカテゴリプロパティの検索を試みます。
宣言
public bool TryFindCategory(string propName, out PropCategory prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindCategory(string) の代わりにこの関数を使用してください。
TryFindCommand(string, out PropCommand)
このプロパティマップ内で指定された名前のコマンドプロパティの検索を試みます。
宣言
public bool TryFindCommand(string propName, out PropCommand prop)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
コマンドプロパティの名前 |
| PropCommand |
prop |
成功時にコマンドプロパティオブジェクトを受け取る出力パラメータ |
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindCommand(string) の代わりにこの関数を使用してください。
TryFindEnumeration(string, out PropEnumeration)
このプロパティマップ内で指定された名前の列挙型プロパティの検索を試みます。
宣言
public bool TryFindEnumeration(string propName, out PropEnumeration prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindEnumeration(string) の代わりにこの関数を使用してください。
TryFindFloat(string, out PropFloat)
このプロパティマップ内で指定された名前の浮動小数点型プロパティの検索を試みます。
宣言
public bool TryFindFloat(string propName, out PropFloat prop)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
浮動小数点型プロパティの名前 |
| PropFloat |
prop |
成功時に浮動小数点型プロパティオブジェクトを受け取る出力パラメータ |
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindFloat(string) の代わりにこの関数を使用してください。
TryFindInteger(string, out PropInteger)
このプロパティマップ内で指定された名前の整数型プロパティの検索を試みます。
宣言
public bool TryFindInteger(string propName, out PropInteger prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindInteger(string) の代わりにこの関数を使用してください。
TryFindRegister(string, out PropRegister)
このプロパティマップ内で指定された名前のレジスタプロパティの検索を試みます。
宣言
public bool TryFindRegister(string propName, out PropRegister prop)
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindRegister(string) の代わりにこの関数を使用してください。
TryFindString(string, out PropString)
このプロパティマップ内で指定された名前の文字列プロパティの検索を試みます。
宣言
public bool TryFindString(string propName, out PropString prop)
パラメータ
| 型 |
名前 |
説明 |
| string |
propName |
文字列プロパティの名前 |
| PropString |
prop |
成功時に文字列プロパティオブジェクトを受け取る出力パラメータ |
戻り値
| 型 |
説明 |
| bool |
プロパティが見つかった場合は true、見つからなかった場合は false |
備考
エラー発生時に例外が発生するのを避けるため、FindString(string) の代わりにこの関数を使用してください。