WsCreateServiceProxyFromTemplate function

Helper routine for creating a service proxy from policy templates.

Syntax

HRESULT WINAPI  WsCreateServiceProxyFromTemplate(
  _In_     WS_CHANNEL_TYPE          channelType,
           const WS_PROXY_PROPERTY* properties,
  _In_     const ULONG              propertyCount,
  _In_     WS_BINDING_TEMPLATE_TYPE templateType,
           void*                    templateValue,
  _In_     ULONG                    templateSize,
  _In_     const void*              templateDescription,
  _In_     ULONG                    templateDescriptionSize,
           WS_SERVICE_PROXY**       serviceProxy,
  _In_opt_ WS_ERROR*                error
);

Parameters

channelType [in]

A WS_CHANNEL_TYPE enumeration value representing the channel type for the service proxy.

properties

An array of WS_PROXY_PROPERTY structures containing optional properties for the service proxy.

The value of this parameter may be NULL, in which case, the propertyCount parameter must be 0 (zero).

propertyCount [in]

The number of properties in the properties array.

templateType [in]

A WS_BINDING_TEMPLATE_TYPE enumeration value representing the type of templates used to create the service proxy. Please see the Remarks for more information.

templateValue

The optional template structure to be created and filled in by an application. This template structure must be consistent with the input template type (in the templateType). When templateValue parameter is NULL, it is equivalent to the corresponding template structure initialized to zero. Please see the Remarks for more information.

templateSize [in]

The size, in bytes, of the template structure (in the templateValue parameter).

templateDescription [in]

The description of templateValue. This must match templateType. Please see the Remarks for more information.

templateDescriptionSize [in]

The size of the template description.

serviceProxy

On success, a pointer that receives the address of the WS_SERVICE_PROXY structure representing the new service proxy. When you no longer need this structure, you must free it by calling WsFreeServiceProxy.

error [in, optional]

Pointer to a WS_ERROR structure that receives additional error information if the function fails.

Return value

If the function succeeds, it returns NO_ERROR; otherwise, it returns an HRESULT error code.

Remarks

WsCreateServiceProxyFromTemplate creates the WS_SERVICE_PROXY structure from input policy templates and additional user input.

The following table shows the mapping between templateType values and the corresponding data types to be used in templateValue and templateDescription.

Requirements