WsSendReplyMessage-Funktion (webservices.h)

Artikel
03/06/2024

Sendet eine Nachricht, bei der es sich um eine Antwort auf eine empfangene Nachricht handelt.

Syntax

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
);

Parameter

[in] channel

Ein Zeiger auf das Channel-Objekt , auf das die Antwortnachricht gesendet werden soll. Der Zeiger muss auf ein gültiges WS_CHANNEL-Objekt verweisen.

[in] replyMessage

Ein Zeiger auf das Message-Objekt zum Senden der Antwort. Der Zeiger muss auf ein gültiges WS_MESSAGE-Objekt verweisen.

Der Status des Nachrichtenobjekts muss auf WS_MESSAGE_STATE_EMPTY oder WS_MESSAGE_STATE_INITIALIZED festgelegt werden.

Hinweis Wenn eine initialisierte Nachricht bereitgestellt wird, muss sie mit WS_REPLY_MESSAGE oder WS_FAULT_MESSAGE initialisiert werden.

[in] replyMessageDescription

Ein Zeiger auf ein WS_MESSAGE_DESCRIPTION-Objekt . Das Aktionsfeldvon WS_MESSAGE_DESCRIPTION wird als Aktionsheader für die Antwortnachricht verwendet. Dieses Feld kann NULL sein, wenn keine Aktion erforderlich ist.

Das BodyElementDescription-Feld des WS_MESSAGE_DESCRIPTION wird verwendet, um den Text der Antwortnachricht zu serialisieren. Dieses Feld kann NULL sein, wenn kein Textelement gewünscht wird. Informationen dazu, wie bodyElementDescription zum Serialisieren eines Werts verwendet wird, finden Sie unter WsWriteBody.

[in] writeOption

Bestimmt, ob das body-Element erforderlich ist und wie der Wert zugeordnet wird.

Weitere Informationen finden Sie unter WS_WRITE_OPTION .

replyBodyValue

Ein voider Zeiger auf den Wert, der in der Antwortnachricht serialisiert werden soll.

[in] replyBodyValueSize

Die Größe des Antwortwerts, der serialisiert wird, in Byte.

[in] requestMessage

Ein Zeiger auf ein WS_MESSAGE-Objekt, das den Anforderungsnachrichtentext kapselt. Dies wird verwendet, um Korrelationsinformationen abzurufen, die beim Formulieren der Antwortnachricht verwendet werden.

Hinweis Die Nachricht kann sich in einem beliebigen Zustand mit Ausnahme WS_MESSAGE_STATE_EMPTY befinden.

[in, optional] asyncContext

Ein Zeiger auf eine WS_ASYNC_CONTEXT Datenstruktur mit Informationen zum asynchronen Aufrufen der Funktion. Ein NULL-Wert gibt eine Anforderung für einen synchronen Vorgang an.

[in, optional] error

Ein Zeiger auf ein WS_ERROR-Objekt , in dem zusätzliche Informationen zum Fehler gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	Beschreibung
WS_S_ASYNC	Der asynchrone Vorgang steht noch aus.
WS_E_OPERATION_ABORTED	Der Vorgang wurde abgebrochen.
WS_E_INVALID_OPERATION	Der Vorgang ist aufgrund des aktuellen Zustands des Objekts nicht zulässig.
WS_E_ENDPOINT_DISCONNECTED	Die Verbindung mit dem Remoteendpunkt wurde beendet.
WS_E_INVALID_FORMAT	Die Eingabedaten hatten nicht das erwartete Format oder hatten nicht den erwarteten Wert.
WS_E_OPERATION_TIMED_OUT	Der Vorgang wurde innerhalb der zugewiesenen Zeit nicht abgeschlossen.
WS_E_QUOTA_EXCEEDED	Ein Kontingent wurde überschritten.
WS_E_SECURITY_VERIFICATION_FAILURE	Die Sicherheitsüberprüfung für die empfangenen Daten war nicht erfolgreich.
WS_E_SECURITY_SYSTEM_FAILURE	Ein Sicherheitsvorgang ist im Windows Web Services-Framework fehlgeschlagen.
WS_E_SECURITY_TOKEN_EXPIRED	Ein Sicherheitstoken wurde vom Server abgelehnt, weil es abgelaufen ist.
E_OUTOFMEMORY	Der Arbeitsspeicher ist nicht mehr vorhanden.
E_INVALIDARG	Mindestens ein Argument ist ungültig.
Andere Fehler	Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Die Antwortnachricht enthält Korrelationsinformationen, je nach WS_ADDRESSING_VERSION. Weitere Informationen zum Korrelieren von Anforderungsantwortnachrichten finden Sie unter Übersicht über die Kanalebene .

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 7 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	webservices.h
Bibliothek	WebServices.lib
DLL	WebServices.dll

Freigeben über