IAPI::SocketObjectPendingOutboundMessageCount

property SocketObjectPendingOutboundMessageCount.

Retrieves the number of ongoing messages ( queued but not sent yet ).

App or script should use this property in order to reduce and regulate memory/network overloading,
while exchanging messages between peers ( server and clients ).

 

HRESULT SocketObjectPendingOutboundMessageCount(
  long hSocketObject,
  long *pVal
);

Parameters

hSocketObject

[in] .   Handle of socket object

pVal

[out, retval] The returned value is a long value.

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