LInet::SendFreeBitmapCmd

#include " ltwrappr.h "

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

LInet * 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.

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

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
//This example sends a message to a remote connection to create a window.
//It is assumed that:
//1.  the network as been started (LInet::StartUp()) 
//2.  a connection has been established with a remote server (LInet::m_Inet.Connect())
class LUserNet3 : public LInet
{
public:
   L_INT  OnConnect(LInet *plConnection, L_INT nError)
   {
      L_INT   nRet = SUCCESS;
      L_CHAR  *pszHostName;
      L_TCHAR strMsg[L_MAXPATH];
      
      if(nError != SUCCESS)
      {
         wsprintf(strMsg, _T("Error[%d]: OnConnect"), nRet);
         MessageBox(NULL, strMsg, 0 , 0);
         return nError;
      }
      
      // Get the remote computer name   
      if ((pszHostName = plConnection->GetHostName(HOST_NAME_IP)) == NULL)      
         return FAILURE;   
      wsprintf(strMsg, _T("OnConnect: Connected to %hs"), (LPTSTR)pszHostName);
      MessageBox(0, strMsg, 0, 0);
      this->SendLoadCmd(plConnection, CMD_LOAD, MAKE_IMAGE_PATH(TEXT("MAGE1.CMP")));
      return nRet;
   }
   L_INT CommandCallBack (LInet * plConnection,
                          CMDTYPE     uCommand,
                          L_UINT      uCommandID,
                          L_INT       nError,
                          L_UINT      uParams, 
                          pPARAMETER  pParams, 
                          L_UINT      uExtra,
                          L_CHAR*pExtra);
};
LUserNet3 m_ClientInet;
L_INT LInet__SendFreeBitmapCmdExample(LInet * pInetRemoteServer, L_UINT uBitmapID)
{
   L_INT nRet = SUCCESS;
   nRet = m_ClientInet.SendFreeBitmapCmd(
      pInetRemoteServer,
      0,
      uBitmapID);
   if(nRet != SUCCESS && nRet != ERROR_DATA_QUEUED)
      return nRet;
   return SUCCESS;
}
//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
L_INT LUserNet3::CommandCallBack (LInet * plConnection,
                              CMDTYPE     uCommand,
                              L_UINT      uCommandID,
                              L_INT       nError,
                              L_UINT      uParams, 
                              pPARAMETER  pParams, 
                              L_UINT      uExtra,
                              L_CHAR*pExtra)
{
   UNREFERENCED_PARAMETER(pExtra);
   UNREFERENCED_PARAMETER(uExtra);
   UNREFERENCED_PARAMETER(uParams);
   UNREFERENCED_PARAMETER(pParams);
   UNREFERENCED_PARAMETER(uCommandID);
   UNREFERENCED_PARAMETER(plConnection);
   L_INT nStatus = ERROR_FEATURE_NOT_SUPPORTED;
   if(nError != SUCCESS)
      nStatus = ERROR_TRANSFER_ABORTED;
   else
   {
      switch(uCommand)
      {
         case CMD_FREE_BITMAP:
         {
            //Add your code here for freeing the bitmap
         } 
         break;
         default: 
         {
            return nStatus; 
         }
      }
   }
   return nStatus;
}