WsSetHeader-Funktion (webservices.h)
Fügt den angegebenen Standardheader in der Nachricht hinzu oder ersetzt diese.
Syntax
HRESULT WsSetHeader(
[in] WS_MESSAGE *message,
[in] WS_HEADER_TYPE headerType,
[in] WS_TYPE valueType,
[in] WS_WRITE_OPTION writeOption,
const void *value,
[in] ULONG valueSize,
[in, optional] WS_ERROR *error
);
Parameter
[in] message
Die Nachricht, in der der Header festgelegt werden soll.
Die Nachricht kann sich in einem beliebigen Zustand befinden, aber WS_MESSAGE_STATE_EMPTY.
[in] headerType
Der Typ des zu serialisierenden Headers.
[in] valueType
Der Typ des zu serialisierenden Werts. Unter WS_HEADER_TYPE finden Sie eine Reihe von Typen, die für jeden Headertyp unterstützt werden.
[in] writeOption
Gibt an, ob das Headerelement erforderlich ist und wie der Wert zugeordnet wird. WS_WRITE_NILLABLE_VALUE und WS_WRITE_NILLABLE_POINTER Schreiboptionen können nicht angegeben werden, da die Headertypen in WS_HEADER_TYPE in den jeweiligen Standardspezifikationen nicht nillierbar sein dürfen. Weitere Informationen finden Sie unter WS_WRITE_OPTION .
value
Der zu serialisierende Headerwert. Weitere Informationen finden Sie unter WS_WRITE_OPTION .
[in] valueSize
Die Größe des zu serialisierenden Werts in Bytes.
[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 |
---|---|
|
In der Nachricht sind mehrere Instanzen des Headertyps vorhanden. |
|
Es war nicht genügend Arbeitsspeicher verfügbar, um den Header zu serialisieren. |
|
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 ermöglicht das Festlegen von Standardheadertypen (siehe WS_HEADER_TYPE). Verwenden Sie für anwendungsdefinierte Headertypen WsAddCustomHeader.
Diese API ist für Handle-Typen von Headern konzipiert, die einmal in der Nachricht angezeigt werden und für den ultimativen Empfänger bestimmt sind. Header, für die eine andere Rolle bzw. ein anderer Akteur als der ultimative Empfänger bestimmt ist, werden von dieser API ignoriert.
Wenn ein Header des angegebenen Typs (für den ultimativen Empfänger) bereits in der Nachricht vorhanden ist, wird er ersetzt.
Anforderungen
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 |