Windows Dev Center

Expand Minimize

WS_PROXY_PROPERTY_ID enumeration

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


enum WS_PROXY_PROPERTY_ID {  WS_PROXY_PROPERTY_CALL_TIMEOUT, 
  WS_PROXY_PROPERTY_MESSAGE_PROPERTIES, 
  WS_PROXY_PROPERTY_MAX_CALL_POOL_SIZE, 
  WS_PROXY_PROPERTY_STATE, 
  WS_PROXY_PROPERTY_MAX_PENDING_CALLS, 
  WS_PROXY_PROPERTY_MAX_CLOSE_TIMEOUT, 
  WS_PROXY_FAULT_LANG_ID 

};

Constants

WS_PROXY_PROPERTY_CALL_TIMEOUT

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

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

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

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

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

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

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

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

 

 

Community Additions

ADD
Show:
© 2015 Microsoft