Функция WsGetSecurityTokenProperty (webservices.h)

Статья
08/27/2023

Извлекает поле или свойство из маркера безопасности. Если запрашиваемое свойство не использует параметр кучи , возвращаемые данные принадлежат маркеру безопасности и остаются действительными до тех пор, пока сам маркер безопасности остается действительным. В частности, для маркеров безопасности, извлеченных из полученного сообщения, маркер безопасности и поля, извлеченные из него, действительны только до тех пор, пока сообщение не сброшено или не освобождено.

Если для свойства требуется параметр кучи , то возвращаемые данные хранятся в куче, а время ее существования отсоединяется от базового токена.

Синтаксис

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

Параметры

[in] securityToken

Маркер безопасности, из которого должно быть извлечено свойство.

[in] id

Идентификатор извлекаемого свойства.

value

Расположение для хранения полученного свойства. Указатель должен иметь выравнивание, совместимое с типом свойства .

[in] valueSize

Число байтов, выделенных вызывающим объектом для хранения полученного свойства.

[in, optional] heap

Куча для хранения дополнительных данных свойств. Этот параметр должен иметь значение, отличное от NULL , если запрашиваемое свойство WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY , а в противном случае — значение NULL .

[in, optional] error

Указывает, где должны храниться дополнительные сведения об ошибке в случае сбоя функции.

Возвращаемое значение

Эта функция может возвращать одно из этих значений.

Код возврата	Описание
E_INVALIDARG	Идентификатор свойства не поддерживался для этого объекта или указанный буфер не был достаточно большим для значения.
E_OUTOFMEMORY	Не хватает памяти.
Другие ошибки	Эта функция может возвращать другие ошибки, не перечисленные выше.

Требования

Требование	Значение
Минимальная версия клиента	Windows 7 [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2008 R2 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	webservices.h
Библиотека	WebServices.lib
DLL	WebServices.dll

Поделиться через