Bericht (Windows Web Services)
Een bericht is een object dat gegevens inkapselt die worden verzonden of ontvangen. De structuur van een bericht wordt gedefinieerd door SOAP en bevat een set kopteksten en een hoofdtekst. De headers worden altijd gebufferd in het geheugen, maar de hoofdtekst wordt gelezen en geschreven met een streaming-API.
Berichten hebben een set eigenschappen die kunnen worden gebruikt om optionele instellingen op te geven waarmee het gedrag van een bericht wordt bepaald en om aanvullende informatie over ontvangen berichten (zoals beveiligingsgegevens) op te halen. Zie WS_MESSAGE_PROPERTY_ID voor een volledige lijst met berichteigenschappen.
Een bericht wordt geadresseerd aan een specifiek Eindpuntadres.
Een WS_FAULT is een speciaal type berichtinhoud dat wordt gebruikt om fouten weer te geven die worden geretourneerd vanaf een extern eindpunt.
Berichten ondergaan codering die de XML transformeert naar een lineaire draadindeling voordat ze worden verzonden.
Zie het onderwerp Channel Layer Overview voor meer informatie over berichten.
De volgende voorbeelden illustreren het gebruik van berichten in WWSAPI.
| Voorbeeld | Beschrijving |
|---|---|
| CustomHeaderExample- | Illustreert het gebruik van aangepaste berichtkoppen. |
| MessageEncodingExample | Illustreert het coderen en decoderen van een bericht. |
| ForwardMessageExample | Illustreert het doorsturen van een bericht. |
De volgende API-elementen worden gebruikt met berichten.
| Callback | Beschrijving |
|---|---|
| WS_MESSAGE_DONE_CALLBACK | Hiermee wordt de aanroeper op de hoogte gebracht dat het bericht het gebruik heeft voltooid van de WS_XML_READER structuur die is geleverd aan de functie WsReadEnvelopeStart, of van de WS_XML_WRITER structuur die is geleverd aan de functie WsWriteEnvelopeStart. |
| Opsomming | Beschrijving |
|---|---|
| WS_ADDRESSING_VERSION | De versie van de specificatie die wordt gebruikt voor de adresseringsheaders. |
| WS_ENVELOPE_VERSION | De versie van de specificatie die wordt gebruikt voor de envelopstructuur. |
| WS_HEADER_ATTRIBUTES | Een set vlaggen die de SOAP mustUnderstand en relaykenmerken van een header vertegenwoordigen. |
| WS_HEADER_TYPE | Het type koptekst. |
| WS_MESSAGE_INITIALIZATION | Hiermee geeft u op welke headers de WsInitializeMessage moet worden toegevoegd aan het bericht. |
| WS_MESSAGE_PROPERTY_ID | De id van elke berichteigenschap. |
| WS_MESSAGE_STATE | De status van het bericht. |
| Functie | Beschrijving |
|---|---|
| WsAddressMessage- | Wijst een doeladres toe aan een bericht. |
| WsCheckMustUnderstandHeaders | Controleert of de opgegeven headers op de juiste wijze door de ontvanger zijn begrepen. |
| WsCreateMessage- | Hiermee maakt u een exemplaar van een WS_MESSAGE-object. |
| WsCreateMessageForChannel- | Hiermee maakt u een bericht dat geschikt is voor gebruik met een specifiek kanaal. |
| WsFillBody | Zorgt ervoor dat er voldoende bytes beschikbaar zijn in een bericht om te lezen. |
| WsFlushBody- | Hiermee worden alle verzamelde berichttekstgegevens leeggemaakt die zijn geschreven. |
| WsFreeMessage- | Hiermee wordt de geheugenresource vrijgegeven die is gekoppeld aan een bericht. |
| WsGetCustomHeader- | Hiermee wordt de door de toepassing gedefinieerde header van het bericht gevonden en gedeserialiseerd. |
| WsGetHeader- | Hiermee vindt u een bepaalde standaardkop in het bericht en wordt deze gedeserialiseerd. |
| WsGetHeaderAttributes- | Hiermee wordt een ULONG-parameter gevuld met de WS_HEADER_ATTRIBUTES van het header-element waarop de lezer is positioneerd. |
| WsGetMessageProperty- | Hiermee haalt u een opgegeven eigenschap van het berichtobject op. |
| WsInitializeMessage- | Initialiseert de kopteksten voor het bericht ter voorbereiding op verwerking. |
| WsMarkHeaderAsUnderstood- | Markeert een header zoals begrepen door de toepassing. |
| WsReadBody | Hiermee wordt een waarde van de XML-lezer van het bericht gedeserialiseerd. |
| WsReadEnvelopeEnd- | Leest de afsluitende elementen van een bericht. |
| WsReadEnvelopeStart | Leest de kopteksten van het bericht en bereidt zich voor om de hoofdtekstelementen te lezen. |
| WsRemoveCustomHeader | Hiermee verwijdert u een aangepaste koptekst uit het bericht. |
| WsRemoveHeader- | Hiermee verwijdert u het standaardobject WS_HEADER_TYPE uit een bericht. |
| WsResetMessage- | Hiermee stelt u de berichtstatus weer in op WS_MESSAGE_STATE_EMPTY. |
| WsSetHeader- | Voegt de opgegeven standaardkoptekst in het bericht toe of vervangt deze. |
| WsWriteBody | Hiermee schrijft u een waarde in de hoofdtekst van een bericht. |
| WsWriteEnvelopeEnd- | Hiermee schrijft u de afsluitende elementen van een bericht. |
| WsWriteEnvelopeStart | Hiermee schrijft u het begin van het bericht, inclusief de huidige set kopteksten van het bericht en bereidt u voor om de hoofdtekstelementen te schrijven. |
| Handvat | Beschrijving |
|---|---|
| WS_MESSAGE | Het ondoorzichtige type dat wordt gebruikt om te verwijzen naar een berichtobject. |
| Structuur | Beschrijving |
|---|---|
| WS_FAULT | Een foutwaarde die wordt meegenomen in de hoofdtekst van een bericht, wat aangeeft dat er een verwerkingsfout is opgetreden. |
| WS_FAULT_CODE | Vertegenwoordigt een foutcode. |
| WS_FAULT_REASON | Bevat een uitleg van de fout. |
| WS_MESSAGE_PROPERTIES | Hiermee geeft u een set WS_MESSAGE_PROPERTY structuren. |
| WS_MESSAGE_PROPERTY | Hiermee geeft u een berichtspecifieke instelling op. |