L_InetClearQueue

#include "l_bitmap.h"
#include "ltnet.h"

L_LTNET_API L_INT L_InetClearQueue(hComputer)

L_COMP hComputer;

/* handle of computer */

Clears the LEADTOOLS internal queue used for sending data.

Parameter

Description

hComputer

Handle of the computer

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 L_InetSendData, L_InetSendBitmap, or L_InetSendSound, 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 L_InetSendRawData, 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 L_InetStartUp 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:

L_InetGetQueueSize, L_InetSendData, L_InetSendBitmap, L_InetSendRawData, L_InetSendSound, L_InetStartUp, L_InetShutDown

Topics:

Peer-to-Peer Functions

Example

For an example, refer to L_InetGetQueueSize.