Funzione WsAddCustomHeader (webservices.h)

  • Articolo

Aggiunge l'intestazione definita dall'applicazione specificata al messaggio.

Sintassi

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
);

Parametri

[in] message

Messaggio a cui aggiungere l'intestazione.

Il messaggio può trovarsi in qualsiasi stato tranne WS_MESSAGE_STATE_EMPTY (vedere l'enumerazione WS_MESSAGE_STATE .

[in] headerDescription

Struttura WS_ELEMENT_DESCRIPTION che descrive l'intestazione.

[in] writeOption

Indica se l'elemento di intestazione è obbligatorio e la modalità di allocazione del valore. Per altre informazioni, vedere l'enumerazione WS_WRITE_OPTION .

[in, ref] value

Valore dell'intestazione da serializzare. Per altre informazioni, vedere l'enumerazione WS_WRITE_OPTION .

[in] valueSize

Dimensione del valore serializzato, in byte.

[in] headerAttributes

Valori degli attributi SOAP per l'intestazione.

[in, optional] error

Puntatore a una struttura WS_ERROR che riceve informazioni aggiuntive sull'errore se la funzione ha esito negativo.

Valore restituito

Se la funzione ha esito positivo, restituisce NO_ERROR; in caso contrario, restituisce un codice di errore HRESULT.

Codice restituito Descrizione
WS_E_INVALID_FORMAT
 Nel messaggio sono presenti più istanze dello stesso tipo di intestazione.
E_OUTOFMEMORY
 Memoria insufficiente per completare l'operazione.
E_INVALIDARG
 Uno o più parametri non sono corretti.
Altri errori
Questa funzione può restituire altri errori non elencati in precedenza.

Commenti

La funzione WsAddCustomHeader è progettata per gestire i tipi di intestazioni destinati al ricevitore finale. Le intestazioni destinate a un altro ricevitore vengono ignorate.

Se si sostituisce un'intestazione, chiamare la funzione WsRemoveCustomHeader per rimuovere le istanze esistenti dell'intestazione prima di chiamare WsAddCustomHeader.

Requisiti

Requisito Valore
Client minimo supportato Windows 7 [app desktop | App UWP]
Server minimo supportato Windows Server 2008 R2 [app desktop | App UWP]
Piattaforma di destinazione Windows
Intestazione webservices.h
Libreria WebServices.lib
DLL WebServices.dll