WsSetFaultErrorDetail 函式 (webservices.h)
寫入儲存在 WS_ERROR 物件中的錯誤詳細數據。
語法
HRESULT WsSetFaultErrorDetail(
[in] WS_ERROR *error,
[in] const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
[in] WS_WRITE_OPTION writeOption,
const void *value,
[in] ULONG valueSize
);
參數
[in] error
將包含錯誤資訊的錯誤物件。
[in] faultDetailDescription
錯誤詳細數據描述的指標。
如果錯誤詳細數據描述的動作字段為非 NULL,則會將其設定為WS_ERROR的WS_FAULT_ERROR_PROPERTY_ACTION。
錯誤詳細數據描述的專案描述會描述錯誤詳細數據中的元素格式。
[in] writeOption
如何配置值的相關信息。 如需詳細資訊 ,請參閱WS_WRITE_OPTION 。
value
要串行化之值的指標。
[in] valueSize
要串行化之值的大小,以位元組為單位。
如果值為 NULL,則大小應為 0。
傳回值
此函式可以傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
輸入數據不是預期的格式,或沒有預期的值。 |
|
一或多個引數無效。 |
|
記憶體不足。 |
備註
此 API 會將儲存在 WS_ERROR 物件中WS_FAULT的詳細數據欄位值串行化。
此函式支援下列案例,根據提供的WS_FAULT_DETAIL_DESCRIPTION中WS_ELEMENT_DESCRIPTION的內容:
- 寫入單一專案。 在此情況下, WS_ELEMENT_DESCRIPTION 的 elementLocalName 和 elementNs 欄位應該設定為要寫入之專案的本機名稱和命名空間,而類型和類型描述代表要串行化之值的型別。
- 將多個元素寫入為單一值。 在此情況下, WS_ELEMENT_DESCRIPTION 的 elementLocalName 和 elementNs 欄位應該設定為 NULL,而且應該指定 WS_STRUCT_TYPE 和 WS_STRUCT_DESCRIPTION 。 要串行化之結構值的每個欄位都應該對應至元素 () ,以在錯誤詳細數據中寫入。 writeOption 參數必須是 WS_WRITE_REQUIRED_VALUE 或 WS_WRITE_REQUIRED_POINTER。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 7 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2008 R2 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | webservices.h |
程式庫 | WebServices.lib |
Dll | WebServices.dll |