Meldung (Windows-Webdienste)

Eine Meldung ist ein Objekt, das Daten kapselt, die übertragen oder empfangen werden. Die Struktur einer Meldung wird durch SOAP definiert und enthält eine Reihe von Headern und einen Text. Die Header werden immer im Arbeitsspeicher gepuffert, aber der Text wird mit einer Streaming-API gelesen und geschrieben.

Diagram showing a message with the header being buffered and the body being streamed.

Meldungen verfügen über eine Reihe von Eigenschaften, die verwendet werden können, um optionale Einstellungen anzugeben, die das Verhalten einer Meldung steuern und eine Möglichkeit zum Abrufen zusätzlicher Informationen zu empfangenen Meldungen (z. B. Sicherheitsinformationen) bereitstellen können. Eine vollständige Liste der Meldungseigenschaften finden Sie unter WS_MESSAGE_PROPERTY_ID.

Eine Meldung wird an eine bestimmte Endpunktadresse adressiert.

Ein WS_FAULT ist eine spezielle Art von Meldungsinhalt, die verwendet wird, um Fehler darzustellen, die von einem Remoteendpunkt zurückgegeben werden.

Meldungen durchlaufen eine Codierung, die den XML-Code in ein lineares Drahtformat transformiert, bevor sie übertragen werden.

Weitere Informationen zu Meldungen finden Sie im Thema Übersicht über Kanalebene.

Die folgenden Beispiele veranschaulichen die Verwendung von Meldungen in WWSAPI.

Beispiel BESCHREIBUNG
CustomHeaderExample Veranschaulicht die Verwendung von benutzerdefinierten Meldungsheadern.
MessageEncodingExample Veranschaulicht die Codierung und Decodierung einer Meldung.
ForwardMessageExample Veranschaulicht das Weiterleiten einer Meldung.

 

Die folgenden API-Elemente werden mit Meldungen verwendet.

Rückruf Beschreibung
WS_MESSAGE_DONE_CALLBACK Benachrichtigt den Aufrufer, dass die Meldung die Verwendung der WS_XML_READER-Struktur abgeschlossen hat, die für die WsReadEnvelopeStart-Funktion bereitgestellt wurde, oder der WS_XML_WRITER-Struktur, die für die WsWriteEnvelopeStart-Funktion bereitgestellt wurde.

 

Enumeration Beschreibung
WS_ADDRESSING_VERSION Die Version der Spezifikation, die für die Adressierungsheader verwendet wird.
WS_ENVELOPE_VERSION Die Version der Spezifikation, die für die Umschlagstruktur verwendet wird.
WS_HEADER_ATTRIBUTES Eine Reihe von Flags, die SOAP-MustUnderstand- und Relayattribute eines Headers darstellen.
WS_HEADER_TYPE Der Typ des Headers.
WS_MESSAGE_INITIALIZATION Gibt an, welche Header die WsInitializeMessage der Meldung hinzufügen soll.
WS_MESSAGE_PROPERTY_ID Die ID jeder Meldungseigenschaft.
WS_MESSAGE_STATE Der Status der Meldung.

 

Function Beschreibung
WsAddressMessage Weist einer Meldung eine Zieladresse zu.
WsCheckMustUnderstandHeaders Überprüft, ob angegebene Header vom Empfänger entsprechend verstanden wurden.
WsCreateMessage Erstellt eine Instanz eines WS_MESSAGE-Objekts.
WsCreateMessageForChannel Erstellt eine Meldung, die für die Verwendung mit einem bestimmten Kanal geeignet ist.
WsFillBody Stellt sicher, dass eine ausreichende Anzahl von Bytes in einer Meldung zum Lesen verfügbar ist.
WsFlushBody Löscht alle gesammelten Meldungstextdaten, die geschrieben wurden.
WsFreeMessage Gibt die Speicherressource frei, die einer Meldung zugeordnet ist.
WsGetCustomHeader Sucht den anwendungsdefinierten Header der Meldung und deserialisiert sie.
WsGetHeader Sucht einen bestimmten Standardheader in der Meldung und deserialisiert sie.
WsGetHeaderAttributes Füllt einen ULONG-Parameter mit dem WS_HEADER_ATTRIBUTES aus dem Headerelement auf, auf dem der Reader positioniert ist.
WsGetMessageProperty Ruft eine angegebene Objekteigenschaft der Meldung ab.
WsInitializeMessage Initialisiert die Header für die Meldung in Vorbereitung auf die Verarbeitung.
WsMarkHeaderAsUnderstood Markiert einen Header so, wie es von der Anwendung verstanden wird.
WsReadBody Deserialisiert einen Wert aus dem XML-Reader der Meldung.
WsReadEnvelopeEnd Liest die schließende Elemente einer Meldung.
WsReadEnvelopeStart Liest die Header der Meldung und bereitet das Lesen der Textelemente vor.
WsRemoveCustomHeader Entfernt einen benutzerdefinierten Header aus der Meldung.
WsRemoveHeader Entfernt das Standardobjekt WS_HEADER_TYPE aus einer Meldung.
WsResetMessage Legt den Meldungsstatus wieder auf WS_MESSAGE_STATE_EMPTY fest.
WsSetHeader Fügt den angegebenen Standardheader in der Meldung hinzu oder ersetzt ihn.
WsWriteBody Schreibt einen Wert im Text einer Meldung.
WsWriteEnvelopeEnd Schreibt die schließende Elemente einer Meldung.
WsWriteEnvelopeStart Schreibt den Anfang der Meldung, einschließlich der aktuellen Header der Meldung, und bereitet das Schreiben der Textelemente vor.

 

Handle Beschreibung
WS_MESSAGE Der undurchsichtige Typ, der verwendet wird, um auf ein Meldungsobjekt zu verweisen.

 

Struktur Beschreibung
WS_FAULT Ein Fehlerwert, der im Text einer Meldung enthalten ist und auf einen Verarbeitungsfehler hinweist.
WS_FAULT_CODE Stellt einen Fehlercode dar.
WS_FAULT_REASON Enthält eine Erklärung des Fehlers.
WS_MESSAGE_PROPERTIES Gibt einen Satz von WS_MESSAGE_PROPERTY-Strukturen an.
WS_MESSAGE_PROPERTY Gibt eine meldungsspezifische Einstellung an.