WsGetHeader-Funktion (webservices.h)
Sucht einen bestimmten Standardheader in der Nachricht und deserialisiert ihn.
Syntax
HRESULT WsGetHeader(
[in] WS_MESSAGE *message,
[in] WS_HEADER_TYPE headerType,
[in] WS_TYPE valueType,
[in] WS_READ_OPTION readOption,
[in, optional] WS_HEAP *heap,
void *value,
[in] ULONG valueSize,
[in, optional] WS_ERROR *error
);
Parameter
[in] message
Die Nachricht, die den Header enthält.
Die Nachricht kann sich in einem beliebigen Zustand befinden, aber WS_MESSAGE_STATE_EMPTY.
[in] headerType
Der Typ des zu deserialisierenden Headers.
[in] valueType
Der Typ des zu deserialisierenden Werts. Unter WS_HEADER_TYPE finden Sie den Satz von Typen, die den einzelnen Headertypen entsprechen.
[in] readOption
Ob der Wert erforderlich ist und wie der Wert zugeordnet wird. WS_READ_NILLABLE_VALUE und WS_READ_NILLABLE_POINTER Leseoptionen können nicht angegeben werden, da die Headertypen in WS_HEADER_TYPE nicht in den jeweiligen Standardspezifikationen nillierbar sein dürfen. Weitere Informationen finden Sie unter WS_READ_OPTION .
[in, optional] heap
Der Heap, in dem die deserialisierten Headerdaten gespeichert werden sollen. Wenn dies NULL ist, wird der Nachrichtenheap verwendet.
value
Die Interpretation dieses Parameters hängt vom WS_READ_OPTION ab.
[in] valueSize
Die Interpretation dieses Parameters hängt vom WS_READ_OPTION ab.
[in, optional] error
Gibt an, wo zusätzliche Fehlerinformationen gespeichert werden sollen, wenn die Funktion fehlschlägt.
Rückgabewert
Diese Funktion kann einen dieser Werte zurückgeben.
Rückgabecode | Beschreibung |
---|---|
|
Der Header ist nicht vorhanden und erforderlich.
Es sind mehrere Instanzen des Headertyps in der Nachricht vorhanden. Die Eingabedaten waren nicht im erwarteten Format. |
|
Das Größenkontingent des Heaps wurde überschritten. |
|
Zum Deserialisieren des Headers war nicht genügend Arbeitsspeicher verfügbar. |
|
Einer oder mehrere der Parameter sind falsch. |
|
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind. |
Hinweise
Diese API bietet Zugriff auf eine Reihe von Standardheadertypen (siehe WS_HEADER_TYPE). Verwenden Sie für anwendungsdefinierte Headertypen WsGetCustomHeader.
Bei dieser API handelt es sich um Handle-Typen von Headern, die einmal in der Nachricht angezeigt werden und für den ultimativen Empfänger bestimmt sind. Header, die auf eine andere Rolle/einen anderen Akteur als den ultimativen Empfänger abzielen, werden von dieser API ignoriert.
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 |