WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 作業系統: Linux, Windows

PropertyContext

PropertyContext 是一種抽象超類別,內含用來取得和設定內容的方法。這些方法可供其他類別繼承。

繼承階層:

方法

方法摘要:
方法 說明
getBooleanProperty 取得名稱所識別之 Boolean 內容的值。
getByteProperty 取得名稱所識別之位元組內容的值。
getBytesProperty 取得名稱所識別之位元組陣列內容的值。
getCharProperty 取得名稱所識別之二位元組字元內容的值。
getDoubleProperty 取得名稱所識別之倍精準度浮點數內容的值。
getFloatProperty 取得名稱所識別之浮點數內容的值。
getIntProperty 取得名稱所識別之整數內容的值。
getLongProperty 取得名稱所識別之長整數內容的值。
getObjectProperty 取得名稱所識別之內容的值和資料類型。
getProperty 取得名稱所識別之內容的 Properties 物件。
getShortProperty 取得名稱所識別之短整數內容的值。
getStringProperty 取得名稱所識別之字串內容的值。
setBooleanProperty 設定名稱所識別之 Boolean 內容的值。
setByteProperty 設定名稱所識別之位元組內容的值。
setBytesProperty 設定名稱所識別之位元組陣列內容的值。
setCharProperty 設定名稱所識別之二位元組字元內容的值。
setDoubleProperty 設定名稱所識別之倍精準度浮點數內容的值。
setFloatProperty 設定名稱所識別之浮點數內容的值。
setIntProperty 設定名稱所識別之整數內容的值。
setLongProperty 設定名稱所識別之長整數內容的值。
setObjectProperty 設定名稱所識別之內容的值和資料類型。
setProperty 使用 Properties 物件來設定內容的值。
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(輸出)
陣列中的位元組數。如果您在輸入中指定一個空值指標, 則不會傳回陣列的長度。
傳回:
陣列中的位元組數。
執行緒環境定義:
由子類別決定
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getCharProperty – 取得字元內容

介面:
xmsCHAR16 getCharProperty(const String & propertyName) const;

取得名稱所識別之二位元組字元內容的值。

參數:
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(輸出)
內容值的長度(以位元組計)。如果值為一個字串而需要轉換資料, 則此為轉換後的長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
傳回:
內容值的資料類型,可為下列一種物件類型:
  • 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;

取得名稱所識別之內容的 Properties 物件。

參數:
propertyName(輸入)
封裝內容名稱的 String 物件。
傳回:
Properties 物件。
執行緒環境定義:
由子類別決定
異常狀況:
  • 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);

設定名稱所識別之二位元組字元內容的值。

參數:
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);

使用 Properties 物件來設定內容的值。

參數:
property(輸入)
Properties 物件。
傳回:
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

使用條款 | 評比此網頁

時間戳記前次更新: 25 Apr 2006
(C) Copyright IBM Corporation 2005. All Rights Reserved.
本資訊中心採用 Eclipse 技術。(http://www.eclipse.org)