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
取得するプロパティの ID。
value
取得したプロパティを格納する場所。 ポインターには、 プロパティの型と互換性のあるアラインメントが必要です。
[in] valueSize
取得したプロパティを格納するために呼び出し元によって割り当てられたバイト数。
[in, optional] heap
追加のプロパティ データを格納するヒープ。 クエリ対象のプロパティがWS_SECURITY_TOKEN_PROPERTY_SYMMETRIC_KEYの場合、このパラメーターは NULL 以外にする必要があります。それ以外の場合は NULL にする必要があります。
[in, optional] error
関数が失敗した場合に追加のエラー情報を格納する場所を指定します。
戻り値
この関数は、これらの値のいずれかを返すことができます。
リターン コード | 説明 |
---|---|
|
プロパティ ID がこのオブジェクトでサポートされていないか、指定されたバッファーが値に対して十分な大きさではなかった。 |
|
メモリが不足しました。 |
|
この関数は、上記以外のエラーを返す場合があります。 |
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 7 [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | webservices.h |
Library | WebServices.lib |
[DLL] | WebServices.dll |