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

PropertyContext

PropertyContext クラスには、プロパティーを取得および設定する関数が含まれます。これらの関数は、プロパティーを持つことのできるオブジェクトに対して操作を実行できます。

ErrorBlockIterator、および Property オブジェクトを除くすべてのオブジェクトは、プロパティーを持つことができます。

関数

関数の要約:
関数 説明
xmsGetBooleanProperty 名前で識別される boolean プロパティーの値を取得します。
xmsGetByteArrayProperty 名前で識別されるバイト配列プロパティーの値を取得します。
xmsGetByteArrayPropertyByRef 名前で識別されるバイト配列プロパティーの値へのポインターを取得します。
xmsGetByteProperty 名前で識別されるバイト・プロパティーの値を取得します。
xmsGetCharProperty 名前で識別される 2 バイト文字プロパティーの値を取得します。
xmsGetDoubleProperty 名前で識別される倍精度浮動小数点プロパティーの値を取得します。
xmsGetFloatProperty 名前で識別される浮動小数点プロパティーの値を取得します。
xmsGetHandleTypeId オブジェクトのハンドルのタイプを取得します。
xmsGetIntProperty 名前で識別される整数プロパティーの値を取得します。
xmsGetLongProperty 名前で識別される長整数プロパティーの値を取得します。
xmsGetObjectProperty 名前で識別されるプロパティーの値およびデータ型を取得します。
xmsGetProperty 名前で識別されるプロパティーの Property オブジェクトを取得します。
xmsGetShortProperty 名前で識別される短整数プロパティーの値を取得します。
xmsGetStringProperty 名前で識別されるストリング・プロパティーの値を取得します。
xmsGetStringPropertyByRef 名前で識別されるストリング・プロパティーの値へのポインターを取得します。
xmsSetBooleanProperty 名前で識別される boolean プロパティーの値を設定します。
xmsSetByteProperty 名前で識別されるバイト・プロパティーの値を設定します。
xmsSetByteArrayProperty 名前で識別されるバイト配列プロパティーの値を設定します。
xmsSetCharProperty 名前で識別される 2 バイト文字プロパティーの値を設定します。
xmsSetDoubleProperty 名前で識別される倍精度浮動小数点プロパティーの値を設定します。
xmsSetFloatProperty 名前で識別される浮動小数点プロパティーの値を設定取得します。
xmsSetIntProperty 名前で識別される整数プロパティーの値を設定します。
xmsSetLongProperty 名前で識別される長整数プロパティーの値を設定します。
xmsSetObjectProperty 名前で識別されるプロパティーの値およびデータ型を設定します。
xmsSetProperty Property オブジェクトを使用してプロパティーの値を設定します。
xmsSetShortProperty 名前で識別される短整数プロパティーの値を設定します。
xmsSetStringProperty 名前で識別されるストリング・プロパティーの値を設定します。

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

インターフェース:
xmsRC xmsGetBooleanProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsBOOL *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetByteArrayProperty(xmsHObj object
xmsCHAR *propertyName,
xmsSBYTE *propertyValue,
xmsINT length,
xmsINT *actualLength
xmsHErrorBlock errorBlock) const;

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

この関数の使用方法について詳しくは、値によりバイト配列を戻す C 関数を参照してください。

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
バイトの配列であるプロパティーの値を含むバッファー。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、バイトの配列は戻されませんが、actualLength パラメーターでバイトの配列の長さが戻されます。
actualLength (出力)
配列のバイト数。入力に NULL ポインターを指定すると、配列の長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsGetByteArrayPropertyByRef – 参照によるバイト配列プロパティーの取得

インターフェース:
xmsRC xmsGetByteArrayPropertyByRef(xmsHObj object
xmsCHAR *propertyName,
xmsSBYTE **propertyValue,
xmsINT *length,
xmsHErrorBlock errorBlock) const;

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

この関数の使用方法について詳しくは、参照によりストリングまたはバイト配列を戻す C 関数を参照してください。

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
バイトの配列であるプロパティーの値へのポインター。
length (出力)
配列のバイト数。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetByteProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsSBYTE *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetCharProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsCHAR16 *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetDoubleProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsDOUBLE *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetFloatProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsFLOAT *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsGetHandleTypeId – ハンドル・タイプの取得

インターフェース:
xmsRC xmsGetHandleTypeId(xmsHObj object,
xmsHANDLE_TYPE *handleType,
xmsHErrorBlock errorBlock);

オブジェクトのハンドルのタイプを取得します。

パラメーター:
object (入力)
オブジェクトのハンドル。
handleType (出力)
オブジェクトのハンドルのタイプ。以下の値のいずれかです。
  • XMS_HANDLE_TYPE_CONN
  • XMS_HANDLE_TYPE_CONNFACT
  • XMS_HANDLE_TYPE_CONNMETADATA
  • XMS_HANDLE_TYPE_DEST
  • XMS_HANDLE_TYPE_ERRORBLOCK
  • XMS_HANDLE_TYPE_INITIALCONTEXT
  • XMS_HANDLE_TYPE_ITERATOR
  • XMS_HANDLE_TYPE_MSG
  • XMS_HANDLE_TYPE_MSGCONSUMER
  • XMS_HANDLE_TYPE_MSGPRODUCER
  • XMS_HANDLE_TYPE_QUEUEBROWSER
  • XMS_HANDLE_TYPE_PROPERTY
  • XMS_HANDLE_TYPE_REQUESTOR
  • XMS_HANDLE_TYPE_SESS
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetIntProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsINT *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetLongProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsLONG *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetObjectProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsSBYTE *propertyValue,
xmsINT length,
xmsINT *actualLength,
xmsOBJECT_TYPE *objectType,
xmsHErrorBlock errorBlock);

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

この関数の使用方法について詳しくは、値によりバイト配列を戻す C 関数を参照してください。

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
バイトの配列として戻されるプロパティーの値を含むバッファー。 値がストリングでデータ変換が必要な場合、これは変換後の値です。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、プロパティーの値は戻されませんが、actualLength パラメーターでプロパティーの値の長さが戻されます。
actualLength (出力)
プロパティーの値の長さ (バイト単位)。値がストリングでデータ変換が必要な場合、これは変換後の長さです。入力に NULL ポインターを指定すると、長さが戻されません。
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
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsGetProperty – プロパティーの取得

インターフェース:
xmsRC xmsGetProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsHProperty *property,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
property (出力)
Property オブジェクトのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetShortProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsLONG *propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsGetStringProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsCHAR *propertyValue,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

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

この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値を含むバッファー。データ変換が必要な場合、これは変換後の値です。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、プロパティーの値は戻されませんが、actualLength パラメーターでプロパティーの値の長さが戻されます。
actualLength (出力)
プロパティーの値の長さ (バイト単位)。データ変換が必要な場合、これは変換後の長さです。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsGetStringPropertyByRef – 参照によるストリング・プロパティーの取得

インターフェース:
xmsRC xmsMsgGetStringPropertyByRef(xmsHObj object,
xmsCHAR *propertyName,
xmsCHAR **propertyValue,
xmsINT *length,
xmsHErrorBlock errorBlock);

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

この関数の使用方法について詳しくは、参照によりストリングまたはバイト配列を戻す C 関数を参照してください。

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (出力)
プロパティーの値へのポインター。データ変換が必要な場合、これは変換後の値です。

プロパティーの値はストリングでなければなりません。関数は、別のデータ型の値をストリングに変換しようとはしません。アプリケーションが、ストリングではない値へのポインターを取得するためにこの関数を呼び出した場合、XMS は、エラー・コード XMS_E_TYPE_CONVERSION_FAILED を戻します。

length (出力)
プロパティーの値の長さ (バイト単位)。データ変換が必要な場合、これは変換後の長さです。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsSetBooleanProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsBOOL propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetByteProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsSBYTE propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetByteArrayProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsSBYTE *propertyValue,
xmsINT length
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
バイトの配列であるプロパティーの値。
length (入力)
配列のバイト数。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetCharProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsCHAR16 propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetDoubleProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsDOUBLE propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetFloatProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsFLOAT propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetIntProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsINT propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetLongProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsLONG propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetObjectProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsSBYTE *propertyValue,
xmsINT length,
xmsOBJECT_TYPE objectType,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
バイトの配列としてのプロパティーの値。
length (入力)
配列のバイト数。
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
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

xmsSetProperty – プロパティーの設定

インターフェース:
xmsRC xmsSetProperty(xmsHObj object,
xmsHProperty property,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
property (入力)
Property オブジェクトのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetShortProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsSHORT propertyValue,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
プロパティーの値。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

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

インターフェース:
xmsRC xmsSetStringProperty(xmsHObj object,
xmsCHAR *propertyName,
xmsCHAR *propertyValue,
xmsINT length,
xmsHErrorBlock errorBlock);

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

パラメーター:
object (入力)
オブジェクトのハンドル。
propertyName (入力)
ヌル終了ストリング形式のプロパティー名。
propertyValue (入力)
文字配列としてのプロパティーの値。
length (入力)
プロパティーの値の長さ (バイト単位)。プロパティーの値がヌルで終了し、ヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS が長さを計算できるようにすることも可能です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
オブジェクトのスレッド・コンテキストによって決定
例外:
  • 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)