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

Property

Properties 物件代表某物件的內容。

繼承階層:
Properties 物件有下列三個屬性:
內容名稱
內容的名稱
內容值
內容的值
內容類型
內容值的資料類型

如果應用程式設定 Properties 物件的內容值屬性, 則內容值會取代屬性先前的值。

這個類別為 Helper 類別。

建構子

建構子摘要:
建構子 說明
Property 複製 Properties 物件。
Property 使用內容名稱、內容值和內容類型來建立 Properties 物件。
Property 建立一個不使用任何內容值或內容類型的 Properties 物件。

Property – 複製內容

介面:
Property(const Property & property);

Property & duplicate(const Property & property);

複製 Properties 物件。

參數:
property(輸入)
Properties 物件。
執行緒環境定義:
任何
異常狀況:
  • 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);

使用內容名稱、內容值和內容類型來建立 Properties 物件。

參數:
propertyName(輸入)
封裝內容名稱的 String 物件。
propertyValue(輸入)
內容值。內容類型取決於內容值的資料類型而定。
length(輸入)
內容值的長度(以位元組計)。只有在內容值為位元組陣列時,這個參數才適用。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Property – 建立內容(不使用任何內容值或內容類型)

介面:
Property(const String & propertyName);

Property & create(const String & propertyName);

建立一個不使用任何內容值或內容類型的 Properties 物件。

參數:
propertyName(輸入)
封裝內容名稱的 String 物件。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

方法

方法摘要:
方法 說明
~Property 刪除 Properties 物件。
getBoolean 從 Properties 物件取得 Boolean 內容值。
getByte 從 Properties 物件取得位元組內容值。
getByteArray 從 Properties 物件取得位元組陣列內容值。
getChar 從 Properties 物件取得二位元組字元內容值。
getDouble 從 Properties 物件取得倍精準度浮點數內容值。
getFloat 從 Properties 物件取得浮點數內容值。
getHandle 取得 C 應用程式在存取 Properties 物件時所要使用的控點。
getInt 從 Properties 物件取得整數內容值。
getLong 從 Properties 物件取得長整數內容值。
getShort 從 Properties 物件取得短整數內容值。
getString 從 Properties 物件取得字串內容值。
getTypeId 從 Properties 物件取得內容類型。
isNull 判斷 Properties 物件是否為一個空值物件。
isTypeId 檢查 Properties 物件是否具備指定的內容類型。
name 從 Properties 物件取得內容名稱。
setBoolean 在 Properties 物件中設定一個 Boolean 內容值,並設定內容類型。
setByte 在 Properties 物件中設定一個位元組內容值,並設定內容類型。
setByteArray 在 Properties 物件中設定一個位元組陣列內容值,並設定內容類型。
setChar 在 Properties 物件中設定一個二位元組字元內容值,並設定內容類型。
setDouble 在 Properties 物件中設定一個倍精準度浮點數內容值,並設定內容類型。
setFloat 在 Properties 物件中設定一個浮點數內容值,並設定內容類型。
setInt 在 Properties 物件中設定一個整數內容值,並設定內容類型。
setLong 在 Properties 物件中設定一個長整數內容值,並設定內容類型。
setShort 在 Properties 物件中設定一個短整數內容值,並設定內容類型。
setString 在 Properties 物件中設定一個字串內容值,並設定內容類型。

~Property – 刪除內容

介面:
virtual ~Property();

刪除 Properties 物件。

如果應用程式試著刪除已刪除的 Properties 物件, 則會忽略該呼叫。

參數:
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getBoolean – 取得 Boolean 內容值

介面:
xmsBOOL getBoolean() const;

從 Properties 物件取得 Boolean 內容值。

參數:
傳回:
Boolean 內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getByte – 取得位元組內容值

介面:
xmsSBYTE getByte() const;

從 Properties 物件取得位元組內容值。

參數:
傳回:
位元組內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getByteArray – 取得位元組陣列內容值

介面:
xmsINT getByteArray(xmsSBYTE *propertyValue,
                    const xmsINT length,
                    xmsINT *actualLength) const;

從 Properties 物件取得位元組陣列內容值。

有關此方法用法的詳細資訊, 請參閱會傳回位元組陣列的 C++ 方法

參數:
propertyValue(輸出)
內含內容值(為一個位元組陣列)的緩衝區。
length(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回內容值,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
內容值的長度(以位元組計)。如果您在輸入中指定一個空值指標, 則不會傳回長度。
傳回:
內容值的長度(以位元組計)。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getChar – 取得字元內容值

介面:
xmsCHAR16 getChar() const;

從 Properties 物件取得二位元組字元內容值。

參數:
傳回:
二位元組字元內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getDouble – 取得倍精準度浮點數內容值

介面:
xmsDOUBLE getDouble() const;

從 Properties 物件取得倍精準度浮點數內容值。

參數:
傳回:
倍精準度浮點數內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getFloat – 取得浮點數內容值

介面:
xmsFLOAT getFloat() const;

從 Properties 物件取得浮點數內容值。

參數:
傳回:
浮點數內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getHandle – 取得控點

介面:
xmsHProperty getHandle() const;

取得 C 應用程式在存取 Properties 物件時所要使用的控點。

參數:
傳回:
Properties 物件的控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getInt – 取得整數內容值

介面:
xmsINT getInt() const;

從 Properties 物件取得整數內容值。

參數:
傳回:
整數內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getLong – 取得長整數內容值

介面:
xmsLONG getLong() const;

從 Properties 物件取得長整數內容值。

參數:
傳回:
長整數內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getShort – 取得短整數內容值

介面:
xmsSHORT getShort() const;

從 Properties 物件取得短整數內容值。

參數:
傳回:
短整數內容值。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getString – 取得字串內容值

介面:
String getString() const;

從 Properties 物件取得字串內容值。

參數:
傳回:
封裝字串內容值的 String 物件。如果需要轉換資料, 則此為轉換後的字串。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getTypeId – 取得內容類型

介面:
xmsPROPERTY_TYPE getTypeId() const;

從 Properties 物件取得內容類型。

參數:
傳回:
內容類型,其值為下列之一:
  • 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;

判斷 Properties 物件是否為一個空值物件。

參數:
傳回:
  • 如果 Properties 物件為空值物件,則為 xmsTRUE
  • 如果 Properties 物件不是空值物件,則為 xmsFALSE
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

isTypeId – 檢查內容類型

介面:
xmsBOOL isTypeId(const xmsPROPERTY_TYPE propertyType) const;

檢查 Properties 物件是否具備指定的內容類型。

參數:
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
傳回:
  • 如果 Properties 物件具備指定的內容類型,則為 xmsTRUE
  • 如果 Properties 物件不具備指定的內容類型, 則為 xmsFALSE
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

name – 取得內容名稱

介面:
String name() const;

從 Properties 物件取得內容名稱。

參數:
傳回:
封裝內容名稱的 String 物件。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setBoolean – 設定 Boolean 內容值

介面:
xmsVOID setBoolean(const xmsBOOL propertyValue);

在 Properties 物件中設定一個 Boolean 內容值,並設定內容類型。

參數:
propertyValue(輸入)
Boolean 內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setByte – 設定位元組內容值

介面:
xmsVOID setByte(const xmsSBYTE propertyValue);

在 Properties 物件中設定一個位元組內容值,並設定內容類型。

參數:
propertyValue(輸入)
位元組內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setByteArray – 設定位元組陣列內容值

介面:
xmsVOID setByteArray(const xmsBYTE *propertyValue,
                     const xmsINT length);

在 Properties 物件中設定一個位元組陣列內容值,並設定內容類型。

參數:
propertyValue(輸入)
內容值,為一個位元組陣列。
length(輸入)
內容值的長度(以位元組計)。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setChar – 設定字元內容值

介面:
xmsVOID setChar(const xmsCHAR16 propertyValue);

在 Properties 物件中設定一個二位元組字元內容值,並設定內容類型。

參數:
propertyValue(輸入)
二位元組字元內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setDouble – 設定倍精準度浮點數內容值

介面:
xmsVOID setDouble(const xmsDOUBLE propertyValue);

在 Properties 物件中設定一個倍精準度浮點數內容值,並設定內容類型。

參數:
propertyValue(輸入)
倍精準度浮點數內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setFloat – 設定浮點數內容值

介面:
xmsVOID setFloat(const xmsFLOAT propertyValue);

在 Properties 物件中設定一個浮點數內容值,並設定內容類型。

參數:
propertyValue(輸入)
浮點數內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setInt – 設定整數內容值

介面:
xmsVOID setInt(const xmsINT propertyValue);

在 Properties 物件中設定一個整數內容值,並設定內容類型。

參數:
propertyValue(輸入)
整數內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setLong – 設定長整數內容值

介面:
xmsVOID setLong(const xmsLONG propertyValue);

在 Properties 物件中設定一個長整數內容值,並設定內容類型。

參數:
propertyValue(輸入)
長整數內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setShort – 設定短整數內容值

介面:
xmsVOID setShort(const xmsSHORT propertyValue);

在 Properties 物件中設定一個短整數內容值,並設定內容類型。

參數:
propertyValue(輸入)
短整數內容值。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setString – 設定字串內容值

介面:
xmsVOID setString(const String & propertyValue);

在 Properties 物件中設定一個字串內容值,並設定內容類型。

參數:
propertyValue(輸入)
封裝字串內容值的 String 物件。
傳回:
Void
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

使用條款 | 評比此網頁

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