WS_PROXY_PROPERTY_ID enumeration (webservices.h)

  • Article

Optional parameters for configuring the service proxy. With an exception of WS_PROXY_PROPERTY_STATE all the values are only supported for use with WsCreateServiceProxy as part of the WS_PROXY_PROPERTY* parameter.

Syntax

typedef enum {
  WS_PROXY_PROPERTY_CALL_TIMEOUT = 0,
  WS_PROXY_PROPERTY_MESSAGE_PROPERTIES = 1,
  WS_PROXY_PROPERTY_MAX_CALL_POOL_SIZE = 2,
  WS_PROXY_PROPERTY_STATE = 3,
  WS_PROXY_PROPERTY_MAX_PENDING_CALLS = 4,
  WS_PROXY_PROPERTY_MAX_CLOSE_TIMEOUT = 5,
  WS_PROXY_FAULT_LANG_ID = 6
} WS_PROXY_PROPERTY_ID;

Constants

 
WS_PROXY_PROPERTY_CALL_TIMEOUT
Value: 0
The maximum amount of time in milliseconds for a call to remain pending.
Default is 30000 milliseconds(30 seconds). It is of type ULONG.

If an application wishes to have no timeout associated with a call, it can set the value to INFINITE.


This property is write only.
WS_PROXY_PROPERTY_MESSAGE_PROPERTIES
Value: 1
This property allows the user to specify properties of the message
objects used by the service proxy to send and receive messages.


This property may be specified when the service proxy is created.


The value specified should be of type WS_MESSAGE_PROPERTIES.


The following message properties may be specified:
WS_PROXY_PROPERTY_MAX_CALL_POOL_SIZE
Value: 2
Each call in the service proxy is represented by an object internal to the service proxy.
A call object is designed such that after every call it can be reused.
This allows applications to scale better in scenarios where they expect
large number of calls over the service proxy. The default value for this property is 5.
It is of type USHORT.

This property is write only.
WS_PROXY_PROPERTY_STATE
Value: 3
The current state of the service proxy.
It is of type WS_SERVICE_PROXY_STATE.

This property is read only.


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_PROXY_PROPERTY_MAX_PENDING_CALLS
Value: 4
The maximum number of pending calls allowed on the service proxy. If the
maximum number of calls pending on the service proxy reaches this limit, the
incoming calls will be rejected with WS_E_QUOTA_EXCEEDED (see Windows Web Services Return Values). The default value
for this property is 100.
It is of type ULONG.

This property is write only.
WS_PROXY_PROPERTY_MAX_CLOSE_TIMEOUT
Value: 5
The amount of time in milliseconds the service proxy will wait for the pending calls to complete.
Once the timeout expires, the service proxy will abort itself.


The default value for this property is 5000 (5 seconds).


This property is write only.
It is of type ULONG.
WS_PROXY_FAULT_LANG_ID
Value: 6
The LANGID that would be used for returning a fault. If none specified default user locale will be used. It is of type LANGID.


This property is write only.

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