IAPI::EnableSocketObjectInOutBoundBandwidthPolling

property EnableSocketObjectInOutBoundBandwithPolling. ( Available since v2.34.5 )

Enables or disables in/outbound bandwidths polling and exchanging between client(s) and a TCP/IP server;

coupled with GetSocketObjectInOutBoundBandwidth(…), developers can easily fetch and view statistics

about bandwidth usage between dual way interprocess communications over LAN, WAN or Internet.

• Please, launch ScriptEZ_Svr.vbs (server) and then ScriptEZ.vbs (client) as an illustration.

This property must be called from within onConnectionState(…) or onConnectionRequest(…) callbacks.

HRESULT EnableSocketObjectInOutBoundBandwidthPolling(
 long hSocketObject,
 long enable_or_disable,
 long delayInSeconds,
 BOOL *pVal
);

Parameters

hSocketObject

[in] . Handle of socket object.

enable_or_disable

[in,defaultvalue(1)] .

1 enables

0 disables

delayInSeconds

[in,defaultvalue(20)] .

Delay in seconds to refresh the bandwidths measuring.

pVal

[out, retval] The returned value is TRUE if succeeded, FALSE if failed

Return Values

S_OK

The operation was successfull.

E_POINTER

A NULL pointer was supplied as an argument.

E_UNEXPECTED

An unexpected error occoured.

See Also

IAPI