Funzione WsSetHeader (webservices.h)

  • Articolo

Aggiunge o sostituisce l'intestazione standard specificata nel messaggio.

Sintassi

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

Parametri

[in] message

Messaggio in cui impostare l'intestazione.

Il messaggio può trovarsi in qualsiasi stato, ma WS_MESSAGE_STATE_EMPTY.

[in] headerType

Tipo di intestazione da serializzare.

[in] valueType

Tipo del valore da serializzare. Vedere WS_HEADER_TYPE per il set di tipi supportati per ogni tipo di intestazione.

[in] writeOption

Indica se l'elemento di intestazione è obbligatorio e la modalità di allocazione del valore. non è possibile specificare WS_WRITE_NILLABLE_VALUE e WS_WRITE_NILLABLE_POINTER opzioni di scrittura perché i tipi di intestazione in WS_HEADER_TYPE non possono essere nillable nelle specifiche degli standard corrispondenti. Per altre informazioni, vedere WS_WRITE_OPTION .

value

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

[in] valueSize

Dimensione del valore serializzato, in byte.

[in, optional] error

Specifica dove archiviare informazioni aggiuntive sull'errore se la funzione ha esito negativo.

Valore restituito

Questa funzione può restituire uno di questi valori.

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

Commenti

Questa API consente l'impostazione dei tipi di intestazione standard (vedere WS_HEADER_TYPE). Per i tipi di intestazione definiti dall'applicazione, usare WsAddCustomHeader.

Questa API è progettata per gestire i tipi di intestazioni che vengono visualizzati una volta nel messaggio e sono destinati al ricevitore finale. Le intestazioni destinate a un ruolo/attore diverso dal ricevitore finale vengono ignorate da questa API.

Se nel messaggio esiste già un'intestazione del tipo specificato (destinata al ricevitore finale), viene sostituita.

Requisiti

   
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