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

ErrorBlock

如果 C 函數呼叫失敗,XMS 可將呼叫失敗原因的相關資訊儲存在錯誤區塊中。

如需錯誤區塊和其內容的相關資訊,請參閱錯誤區塊

這個類別中的函數會傳回下列的回覆碼:
回覆碼 意義
XMS_OK 呼叫順利完成。
XMS_E_INVALID_ERROR_BLOCK 因傳給函數的錯誤區塊無效,導致呼叫失敗。
其他任何值 因其他某些原因導致呼叫失敗。

這個類別為 Helper 類別。

函數

函數摘要:
函數 說明
xmsErrorClear 清除錯誤區塊的內容。
xmsErrorCreate 建立錯誤區塊。
xmsErrorDispose 刪除錯誤區塊。
xmsErrorGetErrorCode 取得錯誤碼。
xmsErrorGetErrorData 取得錯誤資料。
xmsErrorGetErrorString 取得錯誤字串。
xmsErrorGetJMSException 取得異常狀況代碼。
xmsErrorGetLinkedError 取得錯誤區塊鏈中之下一個錯誤區塊的控點。

xmsErrorClear – 清除錯誤區塊

介面:
xmsRC xmsErrorClear(xmsHErrorBlock errorBlock);

清除錯誤區塊的內容。

請注意, XMS 會自動清除 API 函數呼叫所傳遞的錯誤區塊內容。

參數:
errorBlock(輸入)
錯誤區塊的控點。
執行緒環境定義:
任何

xmsErrorCreate – 建立錯誤區塊

介面:
xmsRC xmsErrorCreate(xmsHErrorBlock *errorBlock);

建立錯誤區塊。

在新建的錯誤區塊中, 異常狀況代碼為 XMS_X_NO_EXCEPTION。

參數:
errorBlock(輸出)
錯誤區塊的控點。
執行緒環境定義:
任何

xmsErrorDispose – 刪除錯誤區塊

介面:
xmsRC xmsErrorDispose(xmsHErrorBlock *errorBlock);

刪除錯誤區塊。

錯誤區塊鏈中只有第一個錯誤區塊才能明確刪除。藉由刪除鏈中的第一個錯誤區塊, 亦會刪除鏈中的所有後續錯誤區塊。

如果應用程式試著刪除已刪除的錯誤區塊, 則會忽略該呼叫。

參數:
errorBlock(輸入/輸出)
在輸入方面,為錯誤區塊的控點。在輸出方面,函數會傳回空值控點。
執行緒環境定義:
任何

xmsErrorGetErrorCode – 取得錯誤碼

介面:
xmsRC xmsErrorGetErrorCode(xmsHErrorBlock errorBlock,
                           xmsINT *errorCode);

取得錯誤碼。

如需錯誤碼的相關資訊, 請參閱錯誤區塊

參數:
errorBlock(輸入)
錯誤區塊的控點。
errorCode(輸出)
錯誤碼。
執行緒環境定義:
任何

xmsErrorGetErrorData – 取得錯誤資料

介面:
xmsRC xmsErrorGetErrorData(xmsHErrorBlock errorBlock,
                           xmsCHAR *buffer,
                           xmsINT bufferLength,
                           xmsINT *actualLength);

取得錯誤資料。

如需錯誤資料的相關資訊, 請參閱錯誤區塊

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

參數:
errorBlock(輸入)
錯誤區塊的控點。
buffer(輸出)
內含錯誤資料的緩衝區。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回錯誤資料,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
錯誤資料的長度(以位元組計)。如果您在輸入中指定一個空值指標, 則不會傳回長度。
執行緒環境定義:
任何

xmsErrorGetErrorString – 取得錯誤字串

介面:
xmsRC xmsErrorGetErrorString(xmsHErrorBlock errorBlock,
                             xmsCHAR *buffer,
                             xmsINT bufferLength,
                             xmsINT *actualLength);

取得錯誤字串。

如需錯誤字串的相關資訊, 請參閱錯誤區塊

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

參數:
errorBlock(輸入)
錯誤區塊的控點。
buffer(輸出)
內含錯誤字串的緩衝區。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回錯誤字串,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
錯誤字串的長度(以位元組計)。如果您在輸入中指定一個空值指標, 則不會傳回長度。
執行緒環境定義:
任何

xmsErrorGetJMSException – 取得異常狀況代碼

介面:
xmsRC xmsErrorGetJMSException(xmsHErrorBlock errorBlock,
                              xmsJMSEXP_TYPE *exceptionCode);

取得異常狀況代碼。

如需異常狀況代碼的相關資訊, 請參閱錯誤區塊

參數:
errorBlock(輸入)
錯誤區塊的控點。
exceptionCode(輸出)
異常狀況代碼。如果錯誤區塊位於錯誤區塊鏈中,但不是鏈中的第一個, 則異常狀況代碼固定是 XMS_X_GENERAL_EXCEPTION
執行緒環境定義:
任何

xmsErrorGetLinkedError – 取得所鏈結的錯誤

介面:
xmsRC xmsErrorGetLinkedError(xmsHErrorBlock errorBlock,
                             xmsHErrorBlock *linkedError);

取得錯誤區塊鏈中之下一個錯誤區塊的控點。

參數:
errorBlock(輸入)
錯誤區塊的控點。
linkedError(輸出)
鏈中之下一個錯誤區塊的控點。如果鏈中已無其他錯誤區塊,則函數會傳回一個空值控點。
執行緒環境定義:
任何

Reference topic

使用條款 | 評比此網頁

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