WS_SERVICE_PROPERTY_ID enumeration (webservices.h)

  • Article

The optional parameters for configuring the service host. This enumeration is used within the WS_SERVICE_PROPERTY structure when calling WsCreateServiceHost or by itself when calling WsGetServiceHostProperty.

Syntax

typedef enum {
  WS_SERVICE_PROPERTY_HOST_USER_STATE = 0,
  WS_SERVICE_PROPERTY_FAULT_DISCLOSURE = 1,
  WS_SERVICE_PROPERTY_FAULT_LANGID = 2,
  WS_SERVICE_PROPERTY_HOST_STATE = 3,
  WS_SERVICE_PROPERTY_METADATA = 4,
  WS_SERVICE_PROPERTY_CLOSE_TIMEOUT = 5
} WS_SERVICE_PROPERTY_ID;

Constants

 
WS_SERVICE_PROPERTY_HOST_USER_STATE
Value: 0
A void pointer
used with WsCreateServiceHost. This property
is made available to different callbacks and service operations as part of the WS_OPERATION_CONTEXT structure
WS_SERVICE_PROPERTY_FAULT_DISCLOSURE
Value: 1
A WS_FAULT_DISCLOSURE value used with WsCreateServiceHost.
This property is used to specify the disclosure level of the error object when its converted into a fault. The default is WS_MINIMAL_FAULT_DISCLOSURE.
WS_SERVICE_PROPERTY_FAULT_LANGID
Value: 2
A LANGID used with WsGetServiceHostProperty to create a fault. If none is specified, the default user locale will be used.
WS_SERVICE_PROPERTY_HOST_STATE
Value: 3
A WS_SERVICE_HOST_STATE value used with WsGetServiceHostProperty that specifies the current state of the service host.


The returned value is a snapshot of the current state, so it is
possible that the state may have changed before the caller has
had a chance to examine the value.
WS_SERVICE_PROPERTY_METADATA
Value: 4
A WS_SERVICE_METADATA structure used with WsCreateServiceHost that contains the collection of metadata documents used for WS-MetadataExchange by the WS_SERVICE_HOST.

The service name and namespace are used to create a service element inside the WSDL document. The document is identified by means of the service namespace provided as part of WS_SERVICE_METADATA structure.


Note that if a service section is already defined in any of the provided WSDL documents, a service element will not be added on behalf of the application by the runtime.
WS_SERVICE_PROPERTY_CLOSE_TIMEOUT
Value: 5
A ULONG used with WsCreateServiceHost that specifies the maximum amount of time a service model will wait after WsCloseServiceHost is called. Once the timeout expires service host will abort itself.
The default is 5 seconds specified in milliseconds as 5000.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Header webservices.h