Skip to content

Latest commit

 

History

History
194 lines (157 loc) · 6.7 KB

nf-webservices-wscreateserviceproxyfromtemplate.md

File metadata and controls

194 lines (157 loc) · 6.7 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:webservices.WsCreateServiceProxyFromTemplate
WsCreateServiceProxyFromTemplate function (webservices.h)
Helper routine for creating a service proxy from policy templates.
WsCreateServiceProxyFromTemplate
WsCreateServiceProxyFromTemplate function [Web Services for Windows]
webservices/WsCreateServiceProxyFromTemplate
wsw.wscreateserviceproxyfromtemplate
wsw\wscreateserviceproxyfromtemplate.htm
wsw
09a6ee60-ffed-4bab-8747-61c9fee69695
12/05/2018
WsCreateServiceProxyFromTemplate, WsCreateServiceProxyFromTemplate function [Web Services for Windows], webservices/WsCreateServiceProxyFromTemplate, wsw.wscreateserviceproxyfromtemplate
webservices.h
Windows
Windows 7 [desktop apps \| UWP apps]
Windows Server 2008 R2 [desktop apps \| UWP apps]
WebServices.lib
WebServices.dll
Windows
19H1
WsCreateServiceProxyFromTemplate
webservices/WsCreateServiceProxyFromTemplate
c++
APIRef
kbSyntax
DllExport
WebServices.dll
WsCreateServiceProxyFromTemplate

WsCreateServiceProxyFromTemplate function

-description

Helper routine for creating a service proxy from policy templates.

-parameters

-param channelType [in]

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

-param 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).

-param propertyCount [in]

The number of properties in the properties array.

-param 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.

-param 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.

-param templateSize [in]

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

-param templateDescription [in]

The description of templateValue. This must match templateType.

Please see the Remarks for more information.

-param templateDescriptionSize [in]

The size of the template description.

-param 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.

-param error [in, optional]

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

-returns

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.

templateType templateValue templateDescription
WS_HTTP_BINDING_TEMPLATE_TYPE WS_HTTP_BINDING_TEMPLATE WS_HTTP_POLICY_DESCRIPTION
WS_HTTP_SSL_BINDING_TEMPLATE_TYPE WS_HTTP_SSL_BINDING_TEMPLATE WS_HTTP_SSL_POLICY_DESCRIPTION
WS_HTTP_HEADER_AUTH_BINDING_TEMPLATE_TYPE WS_HTTP_HEADER_AUTH_BINDING_TEMPLATE WS_HTTP_HEADER_AUTH_POLICY_DESCRIPTION
WS_HTTP_SSL_HEADER_AUTH_BINDING_TEMPLATE_TYPE WS_HTTP_SSL_HEADER_AUTH_BINDING_TEMPLATE WS_HTTP_SSL_HEADER_AUTH_POLICY_DESCRIPTION
WS_HTTP_SSL_USERNAME_BINDING_TEMPLATE_TYPE WS_HTTP_SSL_USERNAME_BINDING_TEMPLATE WS_HTTP_SSL_USERNAME_POLICY_DESCRIPTION
WS_HTTP_SSL_KERBEROS_APREQ_BINDING_TEMPLATE_TYPE WS_HTTP_SSL_KERBEROS_APREQ_BINDING_TEMPLATE WS_HTTP_SSL_KERBEROS_APREQ_POLICY_DESCRIPTION
WS_TCP_BINDING_TEMPLATE_TYPE WS_TCP_BINDING_TEMPLATE WS_TCP_POLICY_DESCRIPTION
WS_TCP_SSPI_BINDING_TEMPLATE_TYPE WS_TCP_SSPI_BINDING_TEMPLATE WS_TCP_SSPI_POLICY_DESCRIPTION
WS_TCP_SSPI_USERNAME_BINDING_TEMPLATE_TYPE WS_TCP_SSPI_USERNAME_BINDING_TEMPLATE WS_TCP_SSPI_USERNAME_POLICY_DESCRIPTION
WS_TCP_SSPI_KERBEROS_APREQ_BINDING_TEMPLATE_TYPE WS_TCP_SSPI_KERBEROS_APREQ_BINDING_TEMPLATE WS_TCP_SSPI_KERBEROS_APREQ_POLICY_DESCRIPTION
WS_HTTP_SSL_USERNAME_SECURITY_CONTEXT_BINDING_TEMPLATE_TYPE WS_HTTP_SSL_USERNAME_SECURITY_CONTEXT_BINDING_TEMPLATE WS_HTTP_SSL_USERNAME_SECURITY_CONTEXT_POLICY_DESCRIPTION
WS_HTTP_SSL_KERBEROS_APREQ_SECURITY_CONTEXT_BINDING_TEMPLATE_TYPE WS_HTTP_SSL_KERBEROS_APREQ_SECURITY_CONTEXT_BINDING_TEMPLATE WS_HTTP_SSL_KERBEROS_APREQ_SECURITY_CONTEXT_POLICY_DESCRIPTION
WS_TCP_SSPI_USERNAME_SECURITY_CONTEXT_BINDING_TEMPLATE_TYPE WS_TCP_SSPI_USERNAME_SECURITY_CONTEXT_BINDING_TEMPLATE WS_TCP_SSPI_USERNAME_SECURITY_CONTEXT_POLICY_DESCRIPTION
WS_TCP_SSPI_KERBEROS_APREQ_SECURITY_CONTEXT_BINDING_TEMPLATE_TYPE WS_TCP_SSPI_KERBEROS_APREQ_SECURITY_CONTEXT_BINDING_TEMPLATE WS_TCP_SSPI_KERBEROS_APREQ_SECURITY_CONTEXT_POLICY_DESCRIPTION