Función WsGetSecurityTokenProperty (webservices.h)

Extrae un campo o una propiedad de un token de seguridad. Si la propiedad consultada no usa el parámetro del montón , los datos devueltos son propiedad del token de seguridad y permanecen válidos siempre y cuando el propio token de seguridad siga siendo válido. En concreto, para los tokens de seguridad extraídos de un mensaje recibido, el token de seguridad y los campos extraídos de él solo son válidos siempre que el mensaje no se restablezca ni libere.

Si la propiedad requiere el parámetro del montón , los datos devueltos se almacenan en el montón, con su duración desasociada del token subyacente.

Sintaxis

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

Parámetros

[in] securityToken

Token de seguridad del que se debe extraer la propiedad.

[in] id

Identificador de la propiedad que se va a recuperar.

value

Ubicación donde se va a almacenar la propiedad recuperada. El puntero debe tener una alineación compatible con el tipo de la propiedad .

[in] valueSize

Número de bytes asignados por el autor de la llamada para almacenar la propiedad recuperada.

[in, optional] heap

Montón para almacenar datos de propiedades adicionales. Este parámetro debe ser distinto de NULL cuando la propiedad consultada es WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY y debe ser NULL en caso contrario.

[in, optional] error

Especifica dónde se debe almacenar información de error adicional si se produce un error en la función.

Valor devuelto

Esta función puede devolver uno de estos valores.

Requisitos