Fungsi WsGetSecurityTokenProperty (webservices.h)

Artikel
03/03/2024

Mengekstrak bidang atau properti dari token keamanan. Jika properti yang dikueri tidak menggunakan parameter heap , data yang dikembalikan dimiliki oleh token keamanan dan tetap valid selama token keamanan itu sendiri tetap valid. Secara khusus, untuk token keamanan yang diekstrak dari pesan yang diterima, token keamanan dan bidang yang diekstrak darinya hanya berlaku selama pesan tidak diatur ulang atau dibebaskan.

Jika parameter heap diperlukan oleh properti , maka data yang dikembalikan disimpan pada tumpukan, dengan masa pakainya terlepas dari token yang mendasarinya.

Sintaks

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

Parameter

[in] securityToken

Token keamanan tempat properti harus diekstraksi.

[in] id

Id properti yang akan diambil.

value

Lokasi untuk menyimpan properti yang diambil. Penunjuk harus memiliki perataan yang kompatibel dengan jenis properti .

[in] valueSize

Jumlah byte yang dialokasikan oleh penelepon untuk menyimpan properti yang diambil.

[in, optional] heap

Heap untuk menyimpan data properti tambahan. Parameter ini harus non-NULL ketika properti yang dikueri WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY dan harus NULL sebaliknya.

[in, optional] error

Menentukan tempat informasi kesalahan tambahan harus disimpan jika fungsi gagal.

Mengembalikan nilai

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
E_INVALIDARG	Id properti tidak didukung untuk objek ini atau buffer yang ditentukan tidak cukup besar untuk nilai.
E_OUTOFMEMORY	Kehabisan memori.
Kesalahan Lain	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 7 [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 R2 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	webservices.h
Pustaka	WebServices.lib
DLL	WebServices.dll

Bagikan melalui