WsSendReplyMessage 函式 (webservices.h)

  • 發行項

傳送訊息，這是已接收之訊息的回復。

語法

HRESULT WsSendReplyMessage(
  [in]           WS_CHANNEL                   *channel,
  [in]           WS_MESSAGE                   *replyMessage,
  [in]           const WS_MESSAGE_DESCRIPTION *replyMessageDescription,
  [in]           WS_WRITE_OPTION              writeOption,
                 const void                   *replyBodyValue,
  [in]           ULONG                        replyBodyValueSize,
  [in]           WS_MESSAGE                   *requestMessage,
  [in, optional] const WS_ASYNC_CONTEXT       *asyncContext,
  [in, optional] WS_ERROR                     *error
);

參數

[in] channel

要傳送回復訊息之 Channel 物件的指標。 指標必須參考有效的 WS_CHANNEL 物件。

[in] replyMessage

Message 物件的指標，用於傳送回復。 指標必須參考有效的 WS_MESSAGE 物件。

訊息物件狀態必須設定為 WS_MESSAGE_STATE_EMPTY 或 WS_MESSAGE_STATE_INITIALIZED。

注意 如果提供了初始化的訊息，則必須使用 WS_REPLY_MESSAGE 或 WS_FAULT_MESSAGE初始化。
 

[in] replyMessageDescription

WS_MESSAGE_DESCRIPTION 物件的指標。 WS_MESSAGE_DESCRIPTION的動作欄位會當做回覆訊息的動作標頭使用。 如果不需要任何動作，此欄位可以是 NULL 。

WS_MESSAGE_DESCRIPTION的 bodyElementDescription 字段是用來串行化回復訊息的本文。 如果不需要 body 元素，此字段可能是 NULL 。 如需如何使用 bodyElementDescription 串行化值的資訊，請參閱 WsWriteBody。

[in] writeOption

判斷是否需要 body 元素，以及配置值的方式。

如需詳細資訊 ，請參閱WS_WRITE_OPTION 。

replyBodyValue

在回復訊息中串行化之值的 void 指標。

[in] replyBodyValueSize

要串行化之回復值位元組的大小。

[in] requestMessage

封裝要求消息正文之WS_MESSAGE物件的指標。 這是用來取得用來制訂回復訊息的相互關聯資訊。

注意 訊息可以是 WS_MESSAGE_STATE_EMPTY以外的任何狀態。
 

[in, optional] asyncContext

WS_ASYNC_CONTEXT數據結構的指標，其中包含異步叫用函式的相關信息。 NULL 值表示同步作業的要求。

[in, optional] error

WS_ERROR 物件的指標，如果函式失敗，應該儲存錯誤的其他資訊。

傳回值

此函式可以傳回下列其中一個值。

傳回碼 Description
WS_S_ASYNC
 異步操作仍在擱置中。
WS_E_OPERATION_ABORTED
 作業已中止。
WS_E_INVALID_OPERATION
 由於物件的目前狀態，不允許此作業。
WS_E_ENDPOINT_DISCONNECTED
 與遠端端點的連線已終止。
WS_E_INVALID_FORMAT
 輸入數據不是預期的格式，或沒有預期的值。
WS_E_OPERATION_TIMED_OUT
 作業未在配置的時間內完成。
WS_E_QUOTA_EXCEEDED
 超過配額。
WS_E_SECURITY_VERIFICATION_FAILURE
 已接收數據的安全性驗證未成功。
WS_E_SECURITY_SYSTEM_FAILURE
 Windows Web 服務架構中的安全性作業失敗。
WS_E_SECURITY_TOKEN_EXPIRED
 伺服器因為安全性令牌已過期而遭到拒絕。
E_OUTOFMEMORY
 記憶體不足。
E_INVALIDARG
 一或多個引數無效。
其他錯誤
此函式可能會傳回上面未列出的其他錯誤。

備註

回復訊息會視需要包含相互關聯資訊給 WS_ADDRESSING_VERSION。 如需與要求回復訊息相互關聯的詳細資訊，請參閱 通道層 概觀。

規格需求

需求 值
最低支援的用戶端 Windows 7 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 R2 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 webservices.h
程式庫 WebServices.lib
Dll WebServices.dll