WsAddCustomHeader-Funktion (webservices.h)

  • Artikel

Fügt der Nachricht den angegebenen anwendungsdefinierten Header hinzu.

Syntax

HRESULT WsAddCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *headerDescription,
  [in]           WS_WRITE_OPTION              writeOption,
  [in, ref]      const void                   *value,
  [in]           ULONG                        valueSize,
  [in]           ULONG                        headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Parameter

[in] message

Die Nachricht, der der Header hinzugefügt werden soll.

Die Nachricht kann sich in einem beliebigen Zustand mit Ausnahme WS_MESSAGE_STATE_EMPTY befinden (siehe WS_MESSAGE_STATE-Enumeration .

[in] headerDescription

Die WS_ELEMENT_DESCRIPTION Struktur, die den Header beschreibt.

[in] writeOption

Gibt an, ob das Headerelement erforderlich ist und wie der Wert zugeordnet wird. Weitere Informationen finden Sie in der WS_WRITE_OPTION-Enumeration .

[in, ref] value

Der zu serialisierende Headerwert. Weitere Informationen finden Sie in der WS_WRITE_OPTION-Enumeration .

[in] valueSize

Die Größe des zu serialisierenden Werts in Bytes.

[in] headerAttributes

Die Werte der SOAP-Attribute für den Header.

[in, optional] error

Zeiger auf eine WS_ERROR-Struktur , die zusätzliche Fehlerinformationen empfängt, wenn die Funktion fehlschlägt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird NO_ERROR zurückgegeben. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Rückgabecode Beschreibung
WS_E_INVALID_FORMAT
 In der Nachricht sind mehrere Instanzen desselben Headertyps vorhanden.
E_OUTOFMEMORY
 Unzureichender Arbeitsspeicher, um den Vorgang abzuschließen.
E_INVALIDARG
 Einer oder mehrere der Parameter sind falsch.
Andere Fehler
Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Die WsAddCustomHeader-Funktion ist für Handletypen von Headern konzipiert, die auf den endgültigen Empfänger ausgerichtet sind. Header, die auf einen anderen Empfänger ausgerichtet sind, werden ignoriert.

Wenn Sie einen Header ersetzen, rufen Sie die WsRemoveCustomHeader-Funktion auf, um die vorhandenen Instanzen des Headers vor dem Aufrufen von WsAddCustomHeader zu entfernen.

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