WsGetSecurityTokenProperty, fonction (webservices.h)

Article
08/27/2023

Extrait un champ ou une propriété d’un jeton de sécurité. Si la propriété interrogée n’utilise pas le paramètre tas , les données retournées appartiennent au jeton de sécurité et restent valides tant que le jeton de sécurité lui-même reste valide. Plus précisément, pour les jetons de sécurité extraits d’un message reçu, le jeton de sécurité et les champs extraits sont valides uniquement tant que le message n’est pas réinitialisé ou libéré.

Si le paramètre tas est requis par la propriété, les données retournées sont stockées sur le tas, avec leur durée de vie détachée du jeton sous-jacent.

Syntaxe

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

Paramètres

[in] securityToken

Jeton de sécurité à partir duquel la propriété doit être extraite.

[in] id

ID de la propriété à récupérer.

value

Emplacement où stocker la propriété récupérée. Le pointeur doit avoir un alignement compatible avec le type de la propriété.

[in] valueSize

Nombre d’octets alloués par l’appelant pour stocker la propriété récupérée.

[in, optional] heap

Tas pour stocker des données de propriété supplémentaires. Ce paramètre doit être non NULL lorsque la propriété interrogée est WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY et doit avoir la valeur NULL dans le cas contraire.

[in, optional] error

Spécifie l’emplacement où les informations d’erreur supplémentaires doivent être stockées en cas d’échec de la fonction.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
E_INVALIDARG	L’ID de propriété n’était pas pris en charge pour cet objet ou la mémoire tampon spécifiée n’était pas assez grande pour la valeur.
E_OUTOFMEMORY	Nous avons manqué de mémoire.
Autres erreurs	Cette fonction peut renvoyer d’autres erreurs non répertoriées ci-dessus.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	webservices.h
Bibliothèque	WebServices.lib
DLL	WebServices.dll

Partager via