Condividi tramite

Funzione WsGetSecurityTokenProperty (webservices.h)

  • Articolo

Estrae un campo o una proprietà da un token di sicurezza. Se la proprietà con query non usa il parametro heap , i dati restituiti sono di proprietà del token di sicurezza e rimangono validi finché il token di sicurezza stesso rimane valido. In particolare, per i token di sicurezza estratti da un messaggio ricevuto, il token di sicurezza e i campi estratti sono validi solo se il messaggio non viene reimpostato o liberato.

Se il parametro heap è richiesto dalla proprietà , i dati restituiti vengono archiviati nell'heap, con la relativa durata scollegata dal token sottostante.

Sintassi

HRESULT WsGetSecurityTokenProperty(
  [in]           WS_SECURITY_TOKEN             *securityToken,
  [in]           WS_SECURITY_TOKEN_PROPERTY_ID id,
                 void                          *value,
  [in]           ULONG                         valueSize,
  [in, optional] WS_HEAP                       *heap,
  [in, optional] WS_ERROR                      *error
);

Parametri

[in] securityToken

Token di sicurezza da cui estrarre la proprietà.

[in] id

ID della proprietà da recuperare.

value

Posizione in cui archiviare la proprietà recuperata. Il puntatore deve avere un allineamento compatibile con il tipo della proprietà .

[in] valueSize

Numero di byte allocati dal chiamante per archiviare la proprietà recuperata.

[in, optional] heap

Heap per archiviare dati di proprietà aggiuntivi. Questo parametro deve essere diverso da NULL quando la proprietà sottoposta a query è WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY e deve essere NULL in caso contrario.

[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
E_INVALIDARG
 L'ID proprietà non è supportato per questo oggetto o il buffer specificato non è abbastanza grande per il valore.
E_OUTOFMEMORY
 Memoria insufficiente.
Altri errori
Questa funzione può restituire altri errori non elencati in precedenza.

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