WS_SET_CHANNEL_PROPERTY_CALLBACK callback function (webservices.h)

Article
2024-02-22

Handles the WsSetChannelProperty call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_SET_CHANNEL_PROPERTY_CALLBACK WsSetChannelPropertyCallback;

HRESULT WsSetChannelPropertyCallback(
  [in]           void *channelInstance,
  [in]           WS_CHANNEL_PROPERTY_ID id,
                 const void *value,
  [in]           ULONG valueSize,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] channelInstance

The pointer to the state specific to this channel instance, as created by the WS_CREATE_CHANNEL_CALLBACK.

[in] id

The id of the property to set.

value

The pointer to the property value to set. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The size of the property value.

[in, optional] error

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

Return value

Return code	Description
E_INVALIDARG	The property id was not supported for this object. The specified size was not appropriate for the property.
E_OUTOFMEMORY	There was not enough space to set the property value.
Other Errors	This function may return other errors not listed above.

Remarks

See WsSetChannelProperty for information about the contract of this API.

It is up to the custom channel implementation to determine the set of properties it wishes to support.

If a property is not supported, the E_INVALIDARG should be returned. (See Windows Web Services Return Values.)

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	webservices.h

Share via