Edit

Share via

WsGetSecurityContextProperty function (webservices.h)

  • Article

Gets a property of the specified security context.

Syntax

HRESULT WsGetSecurityContextProperty(
  [in]           WS_SECURITY_CONTEXT             *securityContext,
  [in]           WS_SECURITY_CONTEXT_PROPERTY_ID id,
                 void                            *value,
  [in]           ULONG                           valueSize,
  [in, optional] WS_ERROR                        *error
);

Parameters

[in] securityContext

The security context that is queried for its property.

[in] id

The id of the property (one of WS_SECURITY_CONTEXT_PROPERTY_ID).

value

The address to place the retrieved value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The size of the buffer that the caller has allocated for the retrieved value.

[in, optional] error

Specifies where additional error information should be stored if the function fails.

Return value

This function can return one of these values.

Return code Description
E_INVALIDARG
 The property id was not supported for this object or the specified buffer was not large enough for the value.
E_OUTOFMEMORY
 Ran out of memory.
Other Errors
This function may return other errors not listed above.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll