WsInitializeMessage 函式 (webservices.h)

  • 發行項

此函式會初始化訊息的標頭，以準備處理。 初始化訊息之後，應用程式可以新增其他標頭。 成功時，訊息處於 WS_MESSAGE_STATE_INITIALIZED 狀態。 如果函式失敗，則不會發生狀態轉換。

語法

HRESULT WsInitializeMessage(
  [in]           WS_MESSAGE                *message,
  [in]           WS_MESSAGE_INITIALIZATION initialization,
  [in, optional] WS_MESSAGE                *sourceMessage,
  [in, optional] WS_ERROR                  *error
);

參數

[in] message

要初始化之 Message 物件的指標。 Message 必須是 WsCreateMessage 或 WsCreateMessageForChannel 傳回的有效WS_MESSAGE對象實例，而且可能不是 NULL。

[in] initialization

定義訊息初始化。

注意 如果 初始化 值設定為 WS_REPLY_MESSAGE 或 WS_FAULT_MESSAGE 訊息會自動尋址。
 

[in, optional] sourceMessage

用來初始化訊息參數之 訊息 物件的指標。 除非初始化參數具有 WS_DUPLICATE_MESSAGE、 WS_REPLY_MESSAGE或 WS_FAULT_MESSAGE的值，否則此值應該是 NULL。

[in, optional] error

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

傳回值

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

傳回碼 Description
E_OUTOFMEMORY
 記憶體不足。
E_INVALIDARG
 一或多個引數無效。
其他錯誤
此函式可能會傳回上述未列出的其他錯誤。

備註

訊息的初始寄件者應該使用 WsSetHeader 將動作標頭新增至訊息。

必須先呼叫此 API， 才能呼叫 WsWriteEnvelopeStart 或 WsWriteMessageStart 以進行訊息。

規格需求

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