Compartilhar via

Função WsGetSecurityTokenProperty (webservices.h)

  • Artigo

Extrai um campo ou uma propriedade de um token de segurança. Se a propriedade consultada não usar o parâmetro heap , os dados retornados serão de propriedade do token de segurança e permanecerão válidos enquanto o próprio token de segurança permanecer válido. Especificamente, para tokens de segurança extraídos de uma mensagem recebida, o token de segurança e os campos extraídos dele são válidos apenas desde que a mensagem não seja redefinida ou liberada.

Se o parâmetro heap for exigido pela propriedade , os dados retornados serão armazenados no heap, com seu tempo de vida desanexado do token subjacente.

Sintaxe

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

O token de segurança do qual a propriedade deve ser extraída.

[in] id

A ID da propriedade a ser recuperada.

value

O local para armazenar a propriedade recuperada. O ponteiro deve ter um alinhamento compatível com o tipo da propriedade .

[in] valueSize

O número de bytes alocados pelo chamador para armazenar a propriedade recuperada.

[in, optional] heap

Heap para armazenar dados de propriedade adicionais. Esse parâmetro deve ser não NULL quando a propriedade consultada é WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY e deve ser NULL caso contrário.

[in, optional] error

Especifica onde informações adicionais de erro devem ser armazenadas se a função falhar.

Retornar valor

Essa função pode retornar um desses valores.

Código de retorno Descrição
E_INVALIDARG
 Não havia suporte para a ID da propriedade para esse objeto ou o buffer especificado não era grande o suficiente para o valor.
E_OUTOFMEMORY
 Ficou sem memória.
Outros erros
Essa função pode retornar outros erros não listados acima.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 7 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 R2 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho webservices.h
Biblioteca WebServices.lib
DLL WebServices.dll