LInet::ClearQueue

#include "ltwrappr.h"

L_INT LInet::ClearQueue(L_VOID)

Clears the LEADTOOLS internal queue used for sending data.

Returns

SUCCESS The function was successful.

< 1 An error occurred. Refer to Return Codes.

Comments

You can use this function to abort data transfers. This function should be used with care because the remote end has no way of knowing that the send queue has been cleared.

If after using this function you send data using LInet::SendData, LInet::SendBitmap, or LInet::SendSound, then the remote end will be able to detect that new data is being sent and it will abort the previous download. However, if you send data using LInet::SendRawData, you must implement your own mechanism to synchronize the local and remote computers and recover from aborted sends.

You must initialize the LEADTOOLS Peer-to-Peer DLL using LInet::StartUp before calling this function.

Required DLLs and Libraries

LTNET

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LInet::GetQueueSize, LInet::SendData, LInet::SendBitmap, LInet::SendRawData, LInet::SendSound, LInet::StartUp, LInet::ShutDown, Class Members

Example

For an example, refer to LInet::GetQueueSize.