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

PropertyContext

PropertyContext クラスは、プロパティーを取得して設定するメソッドを含む抽象スーパークラスです。これらのメソッドは、その他のクラスによって継承されます。

継承の階層:
なし

メソッド

メソッドの要約:
メソッド 説明
getBooleanProperty 名前で識別される boolean プロパティーの値を取得します。
getByteProperty 名前で識別されるバイト・プロパティーの値を取得します。
getBytesProperty 名前で識別されるバイト配列プロパティーの値を取得します。
getCharProperty 名前で識別される 2 バイト文字プロパティーの値を取得します。
getDoubleProperty 名前で識別される倍精度浮動小数点プロパティーの値を取得します。
getFloatProperty 名前で識別される浮動小数点プロパティーの値を取得します。
getIntProperty 名前で識別される整数プロパティーの値を取得します。
getLongProperty 名前で識別される長整数プロパティーの値を取得します。
getObjectProperty 名前で識別されるプロパティーの値およびデータ型を取得します。
getProperty 名前で識別されるプロパティーの Property オブジェクトを取得します。
getShortProperty 名前で識別される短整数プロパティーの値を取得します。
getStringProperty 名前で識別されるストリング・プロパティーの値を取得します。
setBooleanProperty 名前で識別される boolean プロパティーの値を設定します。
setByteProperty 名前で識別されるバイト・プロパティーの値を設定します。
setBytesProperty 名前で識別されるバイト配列プロパティーの値を設定します。
setCharProperty 名前で識別される 2 バイト文字プロパティーの値を設定します。
setDoubleProperty 名前で識別される倍精度浮動小数点プロパティーの値を設定します。
setFloatProperty 名前で識別される浮動小数点プロパティーの値を設定取得します。
setIntProperty 名前で識別される整数プロパティーの値を設定します。
setLongProperty 名前で識別される長整数プロパティーの値を設定します。
setObjectProperty 名前で識別されるプロパティーの値およびデータ型を設定します。
setProperty Property オブジェクトを使用してプロパティーの値を設定します。
setShortProperty 名前で識別される短整数プロパティーの値を設定します。
setStringProperty 名前で識別されるストリング・プロパティーの値を設定します。

getBooleanProperty – boolean プロパティーの取得

インターフェース:
xmsBOOL getBooleanProperty(const String & propertyName) const;

名前で識別される boolean プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsSBYTE getByteProperty(const String & propertyName) const;

名前で識別されるバイト・プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsINT getBytesProperty(const String & propertyName,
xmsSBYTE *propertyValue,
const xmsINT length,
xmsINT *actualLength) const;

名前で識別されるバイト配列プロパティーの値を取得します。

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

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (出力)
バイトの配列であるプロパティーの値を含むバッファー。
length (入力)
バッファーの長さ (バイト単位)。代わりに XMSC_QUERY_SIZE を指定すると、バイトの配列は戻されませんが、actualLength パラメーターでバイトの配列の長さが戻されます。
actualLength (出力)
配列のバイト数。入力に NULL ポインターを指定すると、配列の長さが戻されません。
戻り値:
配列のバイト数。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsCHAR16 getCharProperty(const String & propertyName) const;

名前で識別される 2 バイト文字プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsDOUBLE getDoubleProperty(const String & propertyName) const;

名前で識別される倍精度浮動小数点プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsFLOAT getFloatProperty(const String & propertyName) const;

名前で識別される浮動小数点プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsINT getIntProperty(const String & propertyName) const;

名前で識別される整数プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsLONG getLongProperty(const String & propertyName) const;

名前で識別される長整数プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

getObjectProperty – オブジェクト・プロパティーの取得

インターフェース:
xmsOBJECT_TYPE getObjectProperty(const String & propertyName,
xmsSBYTE *propertyValue,
const xmsINT length,
xmsINT *actualLength);

名前で識別されるプロパティーの値およびデータ型を取得します。

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

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (出力)
バイトの配列として戻されるプロパティーの値を含むバッファー。値がストリングでデータ変換が必要な場合、これは変換後の値です。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、プロパティーの値は戻されませんが、actualLength パラメーターでプロパティーの値の長さが戻されます。
actualLength (出力)
プロパティーの値の長さ (バイト単位)。値がストリングでデータ変換が必要な場合、これは変換後の長さです。入力に NULL ポインターを指定すると、長さが戻されません。
戻り値:
プロパティーの値のデータ型。以下のオブジェクト・タイプのいずれかです。
  • XMS_OBJECT_TYPE_BOOL
  • XMS_OBJECT_TYPE_BYTE
  • XMS_OBJECT_TYPE_BYTEARRAY
  • XMS_OBJECT_TYPE_CHAR
  • XMS_OBJECT_TYPE_DOUBLE
  • XMS_OBJECT_TYPE_FLOAT
  • XMS_OBJECT_TYPE_INT
  • XMS_OBJECT_TYPE_LONG
  • XMS_OBJECT_TYPE_SHORT
  • XMS_OBJECT_TYPE_STRING
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

getProperty – プロパティーの取得

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

名前で識別されるプロパティーの Property オブジェクトを取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
Property オブジェクト。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsSHORT getShortProperty(const String & propertyName) const;

名前で識別される短整数プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

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

名前で識別されるストリング・プロパティーの値を取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
戻り値:
プロパティーの値を表すストリングをカプセル化している String オブジェクト。 データ変換が必要な場合、これは変換後のストリングです。
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

setBooleanProperty – boolean プロパティーの設定

インターフェース:
xmsVOID setBooleanProperty(const String & propertyName,
const xmsBOOL propertyValue);

名前で識別される boolean プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setByteProperty(const String & propertyName,
const xmsSBYTE propertyValue);

名前で識別されるバイト・プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setBytesProperty(const String & propertyName,
const xmsSBYTE *propertyValue,
const xmsINT length);

名前で識別されるバイト配列プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
バイトの配列であるプロパティーの値。
length (入力)
配列のバイト数。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setCharProperty(const String & propertyName,
const xmsCHAR16 propertyValue);

名前で識別される 2 バイト文字プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setDoubleProperty(const String & propertyName,
const xmsDOUBLE propertyValue);

名前で識別される倍精度浮動小数点プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setFloatProperty(const String & propertyName,
const xmsFLOAT propertyValue);

名前で識別される浮動小数点プロパティーの値を設定取得します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setIntProperty(const String & propertyName,
const xmsINT propertyValue);

名前で識別される整数プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setLongProperty(const String & propertyName,
const xmsLONG propertyValue);

名前で識別される長整数プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setObjectProperty – オブジェクト・プロパティーの設定

インターフェース:
xmsVOID setObjectProperty(const String & propertyName,
const xmsOBJECT_TYPE objectType,
const xmsSBYTE *propertyValue,
const xmsINT length);

名前で識別されるプロパティーの値およびデータ型を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
objectType (入力)
プロパティーの値のデータ型。以下のオブジェクト・タイプのいずれかでなければなりません。
  • XMS_OBJECT_TYPE_BOOL
  • XMS_OBJECT_TYPE_BYTE
  • XMS_OBJECT_TYPE_BYTEARRAY
  • XMS_OBJECT_TYPE_CHAR
  • XMS_OBJECT_TYPE_DOUBLE
  • XMS_OBJECT_TYPE_FLOAT
  • XMS_OBJECT_TYPE_INT
  • XMS_OBJECT_TYPE_LONG
  • XMS_OBJECT_TYPE_SHORT
  • XMS_OBJECT_TYPE_STRING
propertyValue (入力)
バイトの配列としてのプロパティーの値。
length (入力)
配列のバイト数。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

setProperty – プロパティーの設定

インターフェース:
virtual xmsVOID setProperty(const Property & property);

Property オブジェクトを使用してプロパティーの値を設定します。

パラメーター:
property (入力)
Property オブジェクト。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsVOID setShortProperty(const String & propertyName,
const xmsSHORT propertyValue);

名前で識別される短整数プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

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

名前で識別されるストリング・プロパティーの値を設定します。

パラメーター:
propertyName (入力)
プロパティーの名前をカプセル化している String オブジェクト。
propertyValue (入力)
プロパティーの値を表すストリングをカプセル化している String オブジェクト。
戻り値:
Void
スレッド・コンテキスト:
サブクラスによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

Reference topic

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

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