L_InetSendGetMagGlassDataRsp

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

L_LTNET_API L_INT L_InetSendGetMagGlassDataRsp(hComputer, uCommandID, lColorSize, pColor, nMaskPlaneSize, pMaskPlane, nMaskPlaneStart, nMaskPlaneEnd, uExtra, pExtra, nStatus)

L_COMP hComputer;

/* handle to a remote computer */

L_UINT uCommandID;

/* command id */

L_UINT32 lColorSize;

/* size of the colors array */

COLORREF *pColor;

/* an array of colors */

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 */

L_UINT uExtra;

/* length of any extra data */

L_CHAR *pExtra;

/* extra data */

L_INT nStatus;

/* status */

Sends a get Magnifying Glass data response 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.

lColorSize

The size of the colors.

pColor

Pointer to an array of colors that match the position of needed data in the mask plane array. This array of colors is obtained by calling of L_InetGetMagGlassData function.

nMaskPlaneSize

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.

uExtra

The size of the extra data (pExtra). Unused if pExtra is NULL.

pExtra

Pointer to any extra data needed by the response. Pass NULL if the response does not need to pass any extra data.

nStatus

Status of the original command.

Returns

SUCCESS

This function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function sends a response to a command that was sent from a remote computer using the L_InetSendGetMagGlassDataCmd. This response provides the remote computer with the colors array and its size, the mask plane array and its size and the start and end indexes of the mask plane array.

To receive commands, provide an INETCOMMANDCALLBACK function. This function must be set using L_InetSetCommandCallback.

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

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_InetSendGetMagGlassDataCmd, L_InetGetMagGlassData, INETCOMMANDCALLBACK, INETRESPONSECALLBACK

Topics:

Sending Commands and Responses

 

A Client-Server Diagram: Sending Commands and Responses

Example

For an example, refer to L_InetSetCommandCallback.