WsGetSecurityTokenProperty 函式 (webservices.h)
從安全性令牌擷取欄位或屬性。 如果查詢的屬性不使用 堆積 參數,則傳回的數據是由安全性令牌所擁有,只要安全性令牌本身保持有效,就會維持有效狀態。 具體而言,針對從接收的訊息擷取的安全性令牌,從中擷取的安全性令牌和字段只有在訊息未重設或釋放時才有效。
如果 屬性需要 堆積 參數,則傳回的數據會儲存在堆積上,且其存留期與基礎令牌中斷連結。
語法
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
堆積以儲存其他屬性數據。 當查詢的屬性WS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEY且必須是 NULL 時,這個參數必須是非 NULL,否則必須為 NULL。
[in, optional] error
指定函式失敗時應儲存其他錯誤資訊的位置。
傳回值
此函式可以傳回下列其中一個值。
傳回碼 | Description |
---|---|
|
這個物件不支援屬性標識碼,或指定的緩衝區不足以表示值。 |
|
記憶體不足。 |
|
此函式可能會傳回上面未列出的其他錯誤。 |
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 7 [傳統型應用程式 |UWP 應用程式] |
最低支援的伺服器 | Windows Server 2008 R2 [傳統型應用程式 |UWP 應用程式] |
目標平台 | Windows |
標頭 | webservices.h |
程式庫 | WebServices.lib |
Dll | WebServices.dll |