IAPI::GetSocketObjectInOutBoundBandwidth

property GetSocketObjectInOutBoundBandwidth. ( Available since v2.34.5 )

Returns a 4 piped-string items containing in/outbound bandwidths involved into a dual way TCP/IP communication:

1) local inbound bandwidth ( Kbps) - client receiving side (download)

2) local outbound bandwidth ( Kbps) - client sending side (upload)

3) remote inbound bandwidth ( Kbps) - server receiving side (download)

4) remote outbound bandwidth ( Kbps) - server sending side (upload).

Values are provided by computing the average of data amount sent or received within a refresh delay which is passed

as a parameter to EnableSocketObjectInOutBoundBandwidthPolling(…) property.

For example: “115.09 Kbps|0.00 Kbps|0.00 Kbps|114.00 Kbps|” is a result from a call of this property.

HRESULT GetSocketObjectInOutBoundBandwidth (
 long hSocketObject,
 BSTR *pVal
);

Parameters

hSocketObject

[in] . Handle of socket object.

pVal

[out, retval]

The returned value is a BSTR piped-string to be freed by FreeBSTR() after use.

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