L_InetSendGetMagGlassDataCmd

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

L_LTNET_API L_INT L_InetSendGetMagGlassDataCmd (hComputer, uCommandID, uBitmapID, uMaskPlaneSize, pMaskPlane, nMaskPlaneStart, nMaskPlaneEnd)

L_COMP hComputer;	/* handle to a remote computer */
L_UINT uCommandID;	/* command id */
L_UINT uBitmapID;	/* bitmap id */
L_UINT32 nMaskPlaneSize;	/* size of the bit flags array */
L_UCHAR *pMaskPlane;	/* pointer to a buffer that will contain an array of bit flags */
L_INT nMaskPlaneStart;	/* start index of the mask plane array */
L_INT nMaskPlaneEnd;	/* end index of the mask plane array */

Sends a get Magnifying Glass data command to a remote computer.

Parameter	Description
hComputer	Handle of the remote computer to which the command will be sent.
uCommandID	Command ID. Each command sent by a member of a connection should have a unique ID. Since a member of a connection may send several commands, this ID allows that member to identify when a specific command request has been completed.
uBitmapID	The id of the bitmap from which to get Magnifying Glass data.
uMaskPlaneSize	The size of the bit flags array in bytes.
pMaskPlane	An array of bit flags which represents a mask plane. This array works as a plane for the parts of the bitmap that are not yet updated.
nMaskPlaneStart	The start index of the mask plane array.
nMaskPlaneEnd	The end index of the mask plane array.

Returns

SUCCESS	This function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The remote computer should respond by calling L_InetSendGetMagGlassDataRsp in its INETCOMMANDCALLBACK function. This callback function must be set using L_InetSetCommandCallback.

Once the remote computer receives this command it should call L_InetGetMagGlassData function to get the needed data from the bitmap. The bitmap that the data needed from should exist on the remote computer.

The INETCOMMANDCALLBACK function will receive the uBitmapID, uMaskPlaneSize, pMaskPlane, nMaskPlaneStart and nMaskPlaneEnd information in the pParams parameter. The uBitmapID information will be in pParams[0]. The uMaskPlaneSize information will be in pParams[1], and so forth.

To receive responses to commands, provide an INETRESPONSECALLBACK function. This function must be set using L_InetSetResponseCallback.

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_InetSendGetMagGlassDataRsp, L_InetGetMagGlassData, INETRESPONSECALLBACK, INETCOMMANDCALLBACK
Topics:	Sending Commands and Responses
	A Client-Server Diagram: Sending Commands and Responses

Example

Assume that this function is always called inside the MagGlassCallback function.


L_INT InetSendGetMagGlassDataCmdExample(L_COMP    hComputer,
                                                       L_UINT    uBitmapID,
                                                       L_UINT32  lMaskPlaneSize,
                                                       L_UCHAR * pMaskPlane,
                                                       L_INT     nMaskPlaneStart,
                                                       L_INT     nMaskPlaneEnd,
                                                       L_UINT *guCommandID)
{
   return L_InetSendGetMagGlassDataCmd(hComputer,
                                       *guCommandID++,
                                       uBitmapID,
                                       lMaskPlaneSize,
                                       pMaskPlane,
                                       nMaskPlaneStart,
                                       nMaskPlaneEnd);
}