Funzione WsGetCustomHeader (webservices.h)

Articolo
08/27/2023

Trova un'intestazione definita dall'applicazione del messaggio e la deserializza.

Sintassi

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Parametri

[in] message

Messaggio contenente l'intestazione.

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

[in] customHeaderDescription

WS_ELEMENT_DESCRIPTION che descrive l'elemento intestazione.

[in] repeatingOption

Se l'intestazione può essere visualizzata più di una volta nel messaggio.

Se viene utilizzata WS_REPEATING_HEADER, l'indice di intestazione indica quale delle intestazioni con il nome intestazione specificato da restituire.

Se viene usato WS_SINGLETON_HEADER , l'intestazioneIndex deve essere zero.

[in] headerIndex

Indice in base zero dell'intestazione all'interno del set di intestazioni con il nome intestazione specificato.

[in] readOption

Indica se il valore è obbligatorio e come allocare il valore. Per altre informazioni, vedere WS_READ_OPTION .

[in, optional] heap

Heap in cui archiviare i dati dell'intestazione deserializzati. Se si tratta di NULL, l'heap del messaggio verrà usato come richiesto dal WS_READ_OPTION.

value

L'interpretazione di questo parametro dipende dalla WS_READ_OPTION.

[in] valueSize

L'interpretazione di questo parametro dipende dalla WS_READ_OPTION.

headerAttributes

Restituisce il WS_HEADER_ATTRIBUTES per questa intestazione. Il puntatore può essere NULL, in cui non vengono restituiti attributi.

[in, optional] error

Specifica la posizione in cui devono essere archiviate informazioni aggiuntive sugli errori se la funzione ha esito negativo.

Valore restituito

Questa funzione può restituire uno di questi valori.

Codice restituito	Descrizione
WS_E_INVALID_FORMAT	L'intestazione non esiste ed è necessaria. WS_SINGLETON_HEADER è stato specificato e nel messaggio sono presenti più istanze del tipo di intestazione. I dati di input non erano nel formato previsto.
WS_E_QUOTA_EXCEEDED	La quota di dimensioni dell'heap è stata superata.
E_OUTOFMEMORY	Memoria insufficiente per deserializzare l'intestazione.
E_INVALIDARG	Uno o più parametri non sono corretti.
Altri errori	Questa funzione può restituire altri errori non elencati sopra.

Commenti

Questa API opera sulle intestazioni destinate al ricevitore finale.
Le intestazioni destinate a un ruolo/attore diverso dal ricevitore finale vengono ignorate da questa API.

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