LInet::SendFreeBitmapCmd

#include " ltwrappr.h "

L_INT LInet::SendFreeBitmapCmd (plRemoteComp, uCommandID, uBitmapID)

LInet L_FAR * plRemoteComp;	/* instance of a remote computer */
L_UINT uCommandID;	/* command id */
L_UINT uBitmapID;	/* bitmap id */

Sends a free bitmap command to a remote computer. This function is only available in the Internet toolkit.

Parameter	Description
plRemoteComp	Instance 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 that should be freed.

Returns

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

Comments

The remote computer should free the bitmap associated with uBitmapID and respond by calling LInet::SendFreeBitmapRspin its LInet::CommandCallBackfunction.

The LInet::CommandCallBackfunction will receive the uBitmapID information in the pParams parameter. The uBitmapID information will be in pParams[0].

To process responses to commands, a class must be derived from LInet and the LInet::ResponseCallBackmember function must be overridden.

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::SendFreeBitmapRsp, LInet::ResponseCallBack, LInet::CommandCallBack, Class Members
Topics:	Sending Commands and Responses
	A Client Server Diagram: Sending Commands and Responses

Example

//This example sends a message to a remote connection to free a bitmap
//It is assumed that:
//1.  m_Inet and m_pInetRemoteServer are an object of the class LInet.
//2.  the network as been started (LInet::StartUp())
//3.  a connection has been established with a remote server (LInet::m_Inet.Connect())
//4.  GetNextCommandID() is a function that returns a unique command identifier
//5.  UpdateStatusbar() is a function that displays a message in the status bar
//6.  m_uBitmapID is a bitmap id that is received in the LInet::ResponseCallBack() as a result
//    of a call to m_Inet.SendLoadCmd()
void CMainFrame::OnRemoteSendfreebitmapcmd ()
{
   L_INT nRet = SUCCESS;

   nRet = m_Inet.SendFreeBitmapCmd(
      m_pInetRemoteServer,
      GetNextCommandID(),
      m_uBitmapID
      );

   if(nRet != SUCCESS && nRet != ERROR_DATA_QUEUED)
      UpdateStatusbar(TEXT("Error[%d] OnRemoteSendfreebitmapcmd"), nRet);
}

//The CommandCallBack() is processed on the server
//To process the commands sent to the computer, you must:
//1. Derive a class from LInet
//2. Override the CommandCallBack member function
//
//Assume that
//1. m_Inet is an object of the class CMyNet (derived from LInet).
//2. the network as been started (LInet::StartUp())
//3. a connection has been established with a remote client
//4. UpdateStatusbar() displays a message in the status bar
//5. m_BitmapList maintains a list of LBitmapWindow objects
L_INT CMyNet::CommandCallBack (LInet L_FAR * plConnection,
                              CMDTYPE     uCommand,
                              L_UINT      uCommandID,
                              L_INT       nError,
                              L_UINT      uParams,
                              pPARAMETER  pParams,
                              L_UINT      uExtra,
                              L_CHAR L_FAR*pExtra)
{
   L_INT nStatus = ERROR_FEATURE_NOT_SUPPORTED;
   L_UINT          uBitmapID = (L_UINT)-1;

   CMainFrame *pMain;
   pMain = GETMAINFRAME;

   if(nError != SUCCESS)
      nStatus = ERROR_TRANSFER_ABORTED;
   else
      switch(uCommand)
   {
      case CMD_FREE_BITMAP:
      {
            L_INT nStatus    = SUCCESS;
            L_UINT uBitmapID = pParams[0].uiValue;

            nStatus = m_BitmapList.DeleteBitmap (uBitmapID);
            pMain->UpdateWindow();
            return pMain->m_Inet.SendFreeBitmapRsp (plConnection, uCommandID, 0, NULL, nStatus);
      }
      break;
      default:
      {
         return nStatus;
      }
   }
   return nStatus;
}