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

Property

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

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

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

這個類別為 Helper 類別。

函數

函數摘要:
函數 說明
xmsPropertyCreate 建立一個不使用任何內容值或內容類型的 Properties 物件。
xmsPropertyDispose 刪除 Properties 物件。
xmsPropertyDuplicate 複製 Properties 物件。
xmsPropertyGetBoolean 從 Properties 物件取得 Boolean 內容值。
xmsPropertyGetByte 從 Properties 物件取得位元組內容值。
xmsPropertyGetByteArray 從 Properties 物件取得位元組陣列內容值。
xmsPropertyGetByteArrayByRef 取得 Properties 物件中之位元組陣列內容值的指標。
xmsPropertyGetChar 從 Properties 物件取得二位元組字元內容值。
xmsPropertyGetDouble 從 Properties 物件取得倍精準度浮點數內容值。
xmsPropertyGetFloat 從 Properties 物件取得浮點數內容值。
xmsPropertyGetInt 從 Properties 物件取得整數內容值。
xmsPropertyGetLong 從 Properties 物件取得長整數內容值。
xmsPropertyGetName 從 Properties 物件取得內容名稱。
xmsPropertyGetShort 從 Properties 物件取得短整數內容值。
xmsPropertyGetString 從 Properties 物件取得字串內容值。
xmsPropertyGetStringByRef 取得 Properties 物件中之字串內容值的指標。
xmsPropertyGetTypeId 從 Properties 物件取得內容類型。
xmsPropertyIsTypeId 檢查 Properties 物件是否具備指定的內容類型。
xmsPropertySetBoolean 在 Properties 物件中設定一個 Boolean 內容值,並設定內容類型。
xmsPropertySetByte 在 Properties 物件中設定一個位元組內容值,並設定內容類型。
xmsPropertySetByteArray 在 Properties 物件中設定一個位元組陣列內容值,並設定內容類型。
xmsPropertySetChar 在 Properties 物件中設定一個二位元組字元內容值,並設定內容類型。
xmsPropertySetDouble 在 Properties 物件中設定一個倍精準度浮點數內容值,並設定內容類型。
xmsPropertySetFloat 在 Properties 物件中設定一個浮點數內容值,並設定內容類型。
xmsPropertySetInt 在 Properties 物件中設定一個整數內容值,並設定內容類型。
xmsPropertySetLong 在 Properties 物件中設定一個長整數內容值,並設定內容類型。
setShortxmsPropertySetShort 在 Properties 物件中設定一個短整數內容值,並設定內容類型。
xmsPropertySetString 在 Properties 物件中設定一個字串內容值,並設定內容類型。

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

介面:
xmsRC xmsPropertyCreate(xmsCHAR *propertyName,
                        xmsHProperty *property,
                        xmsHErrorBlock errorBlock);

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

參數:
propertyName(輸入)
此內容名稱採用空值終止字串格式。
property(輸出)
Properties 物件的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyDispose – 刪除內容

介面:
xmsRC xmsPropertyDispose(xmsHProperty *property,
                         xmsHErrorBlock errorBlock);

刪除 Properties 物件。

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

參數:
property(輸入/輸出)
在輸入方面,為 Properties 物件的控點。在輸出方面,函數會傳回空值控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyDuplicate – 複製內容

介面:
xmsRC xmsPropertyDuplicate(xmsHProperty property,
                           xmsHProperty *copiedProperty,
                           xmsHErrorBlock errorBlock);

複製 Properties 物件。

參數:
property(輸入)
Properties 物件的控點。
copiedProperty(輸出)
Properties 物件副本的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetBoolean – 取得 Boolean 內容值

介面:
xmsRC xmsPropertyGetBoolean(xmsHProperty property,
                            xmsBOOL *propertyValue,
                            xmsHErrorBlock errorBlock);

從 Properties 物件取得 Boolean 內容值。

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
Boolean 內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetByte – 取得位元組內容值

介面:
xmsRC xmsPropertyGetByte(xmsHProperty property,
                         xmsSBYTE *propertyValue,
                         xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
位元組內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

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

介面:
xmsRC xmsPropertyGetByteArray(xmsHProperty property,
                              xmsSBYTE *propertyValue,
                              xmsINT length,
                              xmsINT *actualLength,
                              xmsHErrorBlock errorBlock);

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

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回位元組陣列的 C 函數

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

xmsPropertyGetByteArrayByRef – 取得參照形式的位元組陣列內容值

介面:
xmsRC xmsPropertyGetByteArrayByRef(xmsHProperty property,
                                   xmsSBYTE **propertyValue,
                                   xmsINT *length,
                                   xmsHErrorBlock errorBlock);

取得 Properties 物件中之位元組陣列內容值的指標。

如需如何使用此函數的相關資訊, 請參閱會以參照形式來傳回字串或位元組陣列的 C 函數

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
內容值(為一個位元組陣列)的指標。
length(輸出)
內容值的長度(以位元組計)。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetChar – 取得字元內容值

介面:
xmsRC xmsPropertyGetChar(xmsHProperty property,
                         xmsCHAR16 *propertyValue,
                         xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
二位元組字元內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

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

介面:
xmsRC xmsPropertyGetDouble(xmsHProperty property,
                           xmsDOUBLE *propertyValue,
                           xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
倍精準度浮點數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetFloat – 取得浮點數內容值

介面:
xmsRC xmsPropertyGetFloat(xmsHProperty property,
                          xmsFLOAT *propertyValue,
                          xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
浮點數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetInt – 取得整數內容值

介面:
xmsRC xmsPropertyGetInt(xmsHProperty property,
                        xmsINT *propertyValue,
                        xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
整數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetLong – 取得長整數內容值

介面:
xmsRC xmsPropertyGetLong(xmsHProperty property,
                         xmsLONG *propertyValue,
                         xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
長整數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetName – 取得內容名稱

介面:
xmsRC xmsPropertyGetName(xmsHProperty property,
                         xmsCHAR *propertyName,
                         xmsINT length,
                         xmsINT *actualLength,
                         xmsHErrorBlock errorBlock);

從 Properties 物件取得內容名稱。

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回字串的 C 函數

參數:
property(輸入)
Properties 物件的控點。
propertyName(輸出)
內含內容名稱的緩衝區。
length(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回內容名稱,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
內容名稱的長度(以位元組計)。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetShort – 取得短整數內容值

介面:
xmsRC xmsPropertyGetShort(xmsHProperty property,
                          xmsSHORT *propertyValue,
                          xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
短整數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetString – 取得字串內容值

介面:
xmsRC xmsPropertyGetString(xmsHProperty property,
                           xmsCHAR *propertyValue,
                           xmsINT length,
                           xmsINT *actualLength,
                           xmsHErrorBlock errorBlock);

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

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回字串的 C 函數

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
內含字串內容值的緩衝區。如果需要轉換資料, 則此為轉換後的值。
length(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回內容值,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
內容值的長度(以位元組計)。如果需要轉換資料, 則此為轉換後的長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetStringByRef – 取得參照形式的字串內容值

介面:
xmsRC xmsPropertyGetStringByRef(xmsHProperty property,
                                xmsCHAR **propertyValue,
                                xmsINT *length,
                                xmsHErrorBlock errorBlock);

取得 Properties 物件中之字串內容值的指標。

如需如何使用此函數的相關資訊, 請參閱會以參照形式來傳回字串或位元組陣列的 C 函數

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸出)
字串內容值的指標。如果需要轉換資料, 則此為轉換後的值。

請注意,內容值必須是一個字串。函數不會試著將另一種資料類型的內容值轉換成字串。如果應用程式呼叫此函數以取得非字串的內容值的指標, 則 XMS 會傳回 XMS_E_TYPE_CONVERSION_FAILED 錯誤碼。

length(輸出)
內容值的長度(以位元組計)。如果需要轉換資料, 則此為轉換後的長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyGetTypeId – 取得內容類型

介面:
xmsRC xmsPropertyGetTypeId(xmsHProperty property,
                           xmsPROPERTY_TYPE *propertyType,
                           xmsHErrorBlock errorBlock);

從 Properties 物件取得內容類型。

參數:
property(輸入)
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
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertyIsTypeId – 檢查內容類型

介面:
xmsRC xmsPropertyIsTypeId(xmsHProperty property,
                          xmsPROPERTY_TYPE propertyType,
                          xmsBOOL *isType,
                          xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
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
isType(輸出)
如果 Properties 物件具備指定的內容類型,則值為 xmsTRUE。如果 Properties 物件不具備指定的內容類型, 則值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetBoolean – 設定 Boolean 內容值

介面:
xmsRC xmsPropertySetBoolean(xmsHProperty property,
                            xmsBOOL propertyValue,
                            xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
Boolean 內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetByte – 設定位元組內容值

介面:
xmsRC xmsPropertySetByte(xmsHProperty property,
                         xmsSBYTE propertyValue,
                         xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
位元組內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

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

介面:
xmsRC xmsPropertySetByteArray(xmsHProperty property,
                              xmsSBYTE *propertyValue,
                              xmsINT length,
                              xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
內容值,為一個位元組陣列
length(輸入)
內容值的長度(以位元組計)。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetChar – 設定字元內容值

介面:
xmsRC xmsPropertySetChar(xmsHProperty Property,
                         xmsCHAR16 propertyValue,
                         xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
二位元組字元內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

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

介面:
xmsRC xmsPropertySetDouble(xmsHProperty property,
                           xmsDOUBLE propertyValue,
                           xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
倍精準度浮點數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetFloat – 設定浮點數內容值

介面:
xmsRC xmsPropertySetFloat(xmsHProperty property,
                          xmsFLOAT propertyValue,
                          xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
浮點數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetInt – 設定整數內容值

介面:
xmsRC xmsPropertySetInt(xmsHProperty property,
                        xmsINT propertyValue,
                        xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
整數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetLong – 設定長整數內容值

介面:
xmsRC xmsPropertySetLong(xmsHProperty property,
                         xmsLONG propertyValue,
                         xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
長整數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetShort – 設定短整數內容值

介面:
xmsRC xmsPropertySetShort(xmsHProperty property,
                          xmsSHORT propertyValue,
                          xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
短整數內容值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsPropertySetString – 設定字串內容值

介面:
xmsRC xmsPropertySetString(xmsHProperty property,
                           xmsCHAR *propertyValue,
                           xmsINT length,
                           xmsHErrorBlock errorBlock);

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

參數:
property(輸入)
Properties 物件的控點。
propertyValue(輸入)
字元陣列形式的字串內容值。
length(輸入)
內容值的長度(以位元組計)。如果內容值在沒有內嵌空值字元下空值終止, 您可以指定 XMSC_CALCULATE_STRING_SIZE,以容許 XMS 計算其長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

使用條款 | 評比此網頁

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