WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

Property

Property オブジェクトは、オブジェクトのプロパティーを表します。

継承の階層:
なし
プロパティー・オブジェクトには、3 つの属性があります。
プロパティー名
プロパティーの名
プロパティー値
プロパティーの値
プロパティー・タイプ
プロパティーの値のデータ型

アプリケーションが Property オブジェクトのプロパティー値属性を設定した場合、そのプロパティー値が、属性の以前の値に置き換わります。

これはヘルパー・クラスです。

コンストラクター

コンストラクターの要約:
コンストラクター 説明
プロパティー Property オブジェクトをコピーします。
プロパティー プロパティー名、プロパティー値、およびプロパティー・タイプを使用して Property オブジェクトを作成します。
プロパティー プロパティー値またはプロパティー・タイプを指定せずに Property オブジェクトを作成します。

Property – プロパティーのコピー

インターフェース:
Property(const Property & property);
Property & duplicate(const Property & property);

Property オブジェクトをコピーします。

パラメーター:
property (入力)
Property オブジェクト。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

Property – プロパティーの作成

インターフェース:
Property(const String & propertyName,
const xmsBOOL propertyValue);
Property(const String & propertyName,
const xmsSBYTE *propertyValue,
xmsINT length);
Property(const String & propertyName,
const xmsSBYTE propertyValue);
Property(const String & propertyName,
const xmsCHAR16 propertyValue);
Property(const String & propertyName,
const xmsDOUBLE propertyValue);
Property(const String & propertyName,
const xmsFLOAT propertyValue);
Property(const String & propertyName,
const xmsINT propertyValue);
Property(const String & propertyName,
const xmsLONG propertyValue);
Property(const String & propertyName,
const xmsSHORT propertyValue);
Property(const String & propertyName,
const String & propertyValue);

プロパティー名、プロパティー値、およびプロパティー・タイプを使用して Property オブジェクトを作成します。

パラメーター:
propertyName (入力)
プロパティー名をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティー値。プロパティー・タイプは、プロパティー値のデータ型によって決まります。
length (入力)
プロパティー値の長さ (バイト単位)。このパラメーターを適用できるのは、プロパティー値がバイトの配列である場合のみです。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

Property – プロパティーの作成 (プロパティー値またはプロパティー・タイプを指定しない)

インターフェース:
Property(const String & propertyName);
Property & create(const String & propertyName);

プロパティー値またはプロパティー・タイプを指定せずに Property オブジェクトを作成します。

パラメーター:
propertyName (入力)
プロパティー名をカプセル化している String オブジェクト。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

メソッド

メソッドの要約:
メソッド 説明
~Property Property オブジェクトを削除します。
getBoolean Property オブジェクトから boolean プロパティー値を取得します。
getByte Property オブジェクトからバイト・プロパティー値を取得します。
getByteArray Property オブジェクトからバイト配列プロパティー値を取得します。
getChar Property オブジェクトから 2 バイト文字プロパティー値を取得します。
getDouble Property オブジェクトから倍精度浮動小数点プロパティー値を取得します。
getFloat Property オブジェクトから浮動小数点プロパティー値を取得します。
getHandle C アプリケーションが Property オブジェクトにアクセスするときに使用するハンドルを取得します。
getInt Property オブジェクトから整数プロパティー値を取得します。
getLong Property オブジェクトから長整数プロパティー値を取得します。
getShort Property オブジェクトから短整数プロパティー値を取得します。
getString Property オブジェクトからストリング・プロパティー値を取得します。
getTypeId Property オブジェクトからプロパティー・タイプを取得します。
isNull Property オブジェクトがヌル・オブジェクトであるかどうかを判別します。
isTypeId Property オブジェクトのタイプが指定されたプロパティー・タイプであるかどうかを検査します。
name Property オブジェクトからプロパティー名を取得します。
setBoolean Property オブジェクトで boolean プロパティー値を設定し、プロパティー・タイプを設定します。
setByte Property オブジェクトでバイト・プロパティー値を設定し、プロパティー・タイプを設定します。
setByteArray Property オブジェクトでバイト配列プロパティー値を設定し、プロパティー・タイプを設定します。
setChar Property オブジェクトで 2 バイト文字プロパティー値を設定し、プロパティー・タイプを設定します。
setDouble Property オブジェクトで倍精度浮動小数点プロパティー値を設定し、プロパティー・タイプを設定します。
setFloat Property オブジェクトで浮動小数点プロパティー値を設定し、プロパティー・タイプを設定します。
setInt Property オブジェクトで整数プロパティー値を設定し、プロパティー・タイプを設定します。
setLong Property オブジェクトで長整数プロパティー値を設定し、プロパティー・タイプを設定します。
setShort Property オブジェクトで短整数プロパティー値を設定し、プロパティー・タイプを設定します。
setString Property オブジェクトでストリング・プロパティー値を設定し、プロパティー・タイプを設定します。

~Property – プロパティーの削除

インターフェース:
virtual ~Property();

Property オブジェクトを削除します。

アプリケーションが、既に削除されている Property オブジェクトを削除しようとした場合、呼び出しは無視されます。

パラメーター:
なし
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getBoolean – boolean プロパティー値の取得

インターフェース:
xmsBOOL getBoolean() const;

Property オブジェクトから boolean プロパティー値を取得します。

パラメーター:
なし
戻り値:
boolean プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getByte – バイト・プロパティー値の取得

インターフェース:
xmsSBYTE getByte() const;

Property オブジェクトからバイト・プロパティー値を取得します。

パラメーター:
なし
戻り値:
バイト・プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getByteArray – バイト配列プロパティー値の取得

インターフェース:
xmsINT getByteArray(xmsSBYTE *propertyValue,
const xmsINT length,
xmsINT *actualLength) const;

Property オブジェクトからバイト配列プロパティー値を取得します。

このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。

パラメーター:
propertyValue (出力)
バイトの配列であるプロパティー値を含むバッファー。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、プロパティー値は戻されませんが、actualLength パラメーターでプロパティー値の長さが戻されます。
actualLength (出力)
プロパティー値の長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
戻り値:
プロパティー値の長さ (バイト単位)。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getChar – 文字プロパティー値の取得

インターフェース:
xmsCHAR16 getChar() const;

Property オブジェクトから 2 バイト文字プロパティー値を取得します。

パラメーター:
なし
戻り値:
2 バイト文字プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getDouble – 倍精度浮動小数点プロパティー値の取得

インターフェース:
xmsDOUBLE getDouble() const;

Property オブジェクトから倍精度浮動小数点プロパティー値を取得します。

パラメーター:
なし
戻り値:
倍精度浮動小数点プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getFloat – 浮動小数点プロパティー値の取得

インターフェース:
xmsFLOAT getFloat() const;

Property オブジェクトから浮動小数点プロパティー値を取得します。

パラメーター:
なし
戻り値:
浮動小数点プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getHandle – ハンドルの取得

インターフェース:
xmsHProperty getHandle() const;

C アプリケーションが Property オブジェクトにアクセスするときに使用するハンドルを取得します。

パラメーター:
なし
戻り値:
Property オブジェクトのハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

getInt – 整数プロパティー値の取得

インターフェース:
xmsINT getInt() const;

Property オブジェクトから整数プロパティー値を取得します。

パラメーター:
なし
戻り値:
整数プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getLong – 長整数プロパティー値の取得

インターフェース:
xmsLONG getLong() const;

Property オブジェクトから長整数プロパティー値を取得します。

パラメーター:
なし
戻り値:
長整数プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getShort – 短整数プロパティー値の取得

インターフェース:
xmsSHORT getShort() const;

Property オブジェクトから短整数プロパティー値を取得します。

パラメーター:
なし
戻り値:
短整数プロパティー値。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getString – ストリング・プロパティー値の取得

インターフェース:
String getString() const;

Property オブジェクトからストリング・プロパティー値を取得します。

パラメーター:
なし
戻り値:
ストリング・プロパティー値をカプセル化している String オブジェクト。データ変換が必要な場合、これは変換後のストリングです。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

getTypeId – プロパティー・タイプの取得

インターフェース:
xmsPROPERTY_TYPE getTypeId() const;

Property オブジェクトからプロパティー・タイプを取得します。

パラメーター:
なし
戻り値:
プロパティー・タイプ。以下の値のいずれかです。
  • XMS_PROPERTY_TYPE_UNKNOWN
  • XMS_PROPERTY_TYPE_BOOL
  • XMS_PROPERTY_TYPE_BYTE
  • XMS_PROPERTY_TYPE_BYTEARRAY
  • XMS_PROPERTY_TYPE_CHAR
  • XMS_PROPERTY_TYPE_STRING
  • XMS_PROPERTY_TYPE_SHORT
  • XMS_PROPERTY_TYPE_INT
  • XMS_PROPERTY_TYPE_LONG
  • XMS_PROPERTY_TYPE_FLOAT
  • XMS_PROPERTY_TYPE_DOUBLE
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

isNull – ヌルであるかどうかを検査

インターフェース:
xmsBOOL isNull() const;

Property オブジェクトがヌル・オブジェクトであるかどうかを判別します。

パラメーター:
なし
戻り値:
  • Property オブジェクトがヌル・オブジェクトの場合は、xmsTRUE
  • Property オブジェクトがヌル・オブジェクトでない場合は、xmsFALSE
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

isTypeId – プロパティー・タイプの検査

インターフェース:
xmsBOOL isTypeId(const xmsPROPERTY_TYPE propertyType) const;

Property オブジェクトのタイプが指定されたプロパティー・タイプであるかどうかを検査します。

パラメーター:
propertyType (入力)
プロパティー・タイプ。以下の値のいずれかでなければなりません。
  • XMS_PROPERTY_TYPE_UNKNOWN
  • XMS_PROPERTY_TYPE_BOOL
  • XMS_PROPERTY_TYPE_BYTE
  • XMS_PROPERTY_TYPE_BYTEARRAY
  • XMS_PROPERTY_TYPE_CHAR
  • XMS_PROPERTY_TYPE_STRING
  • XMS_PROPERTY_TYPE_SHORT
  • XMS_PROPERTY_TYPE_INT
  • XMS_PROPERTY_TYPE_LONG
  • XMS_PROPERTY_TYPE_FLOAT
  • XMS_PROPERTY_TYPE_DOUBLE
戻り値:
  • Property オブジェクトのタイプが、指定されたプロパティー・タイプである場合は、xmsTRUE です。
  • Property オブジェクトのタイプが、指定されたプロパティー・タイプでない場合は、xmsFALSE です。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

name – プロパティー名の取得

インターフェース:
String name() const;

Property オブジェクトからプロパティー名を取得します。

パラメーター:
なし
戻り値:
プロパティー名をカプセル化している String オブジェクト。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setBoolean – boolean プロパティー値の設定

インターフェース:
xmsVOID setBoolean(const xmsBOOL propertyValue);

Property オブジェクトで boolean プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
boolean プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setByte – バイト・プロパティー値の設定

インターフェース:
xmsVOID setByte(const xmsSBYTE propertyValue);

Property オブジェクトでバイト・プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
バイト・プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setByteArray – バイト配列プロパティー値の設定

インターフェース:
xmsVOID setByteArray(const xmsBYTE *propertyValue,
const xmsINT length);

Property オブジェクトでバイト配列プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
バイトの配列であるプロパティー値。
length (入力)
プロパティー値の長さ (バイト単位)。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setChar – 文字プロパティー値の設定

インターフェース:
xmsVOID setChar(const xmsCHAR16 propertyValue);

Property オブジェクトで 2 バイト文字プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
2 バイト文字プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setDouble – 倍精度浮動小数点プロパティー値の設定

インターフェース:
xmsVOID setDouble(const xmsDOUBLE propertyValue);

Property オブジェクトで倍精度浮動小数点プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
倍精度浮動小数点プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setFloat – 浮動小数点プロパティー値の設定

インターフェース:
xmsVOID setFloat(const xmsFLOAT propertyValue);

Property オブジェクトで浮動小数点プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
浮動小数点プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setInt – 整数プロパティー値の設定

インターフェース:
xmsVOID setInt(const xmsINT propertyValue);

Property オブジェクトで整数プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
整数プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setLong – 長整数プロパティー値の設定

インターフェース:
xmsVOID setLong(const xmsLONG propertyValue);

Property オブジェクトで長整数プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
長整数プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setShort – 短整数プロパティー値の設定

インターフェース:
xmsVOID setShort(const xmsSHORT propertyValue);

Property オブジェクトで短整数プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
短整数プロパティー値。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

setString – ストリング・プロパティー値の設定

インターフェース:
xmsVOID setString(const String & propertyValue);

Property オブジェクトでストリング・プロパティー値を設定し、プロパティー・タイプを設定します。

パラメーター:
propertyValue (入力)
ストリング・プロパティー値をカプセル化している String オブジェクト。
戻り値:
Void
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)