LInet::SendSaveCmd
#include " ltwrappr.h "
L_INT LInet::SendSaveCmd (plRemoteComp, uCommandID, pszFile, uBitmapID, nFormat, nBitsPerPixel, nQFactor, uFlags)
LInet * plRemoteComp; |
/* instance of a remote computer */ |
L_UINT uCommandID; |
/* command id */ |
L_TCHAR * pszFile; |
/* file name */ |
L_UINT uBitmapID; |
/* bitmap id */ |
L_INT nFormat; |
/* file format */ |
L_INT nBitsPerPixel; |
/* resulting file's pixel depth */ |
L_INT nQFactor; |
/* quality factor */ |
L_UINT uFlags; |
/* flags that determine the save behavior */ |
Sends a save 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. |
|
pszFile |
Character string containing the name of the image file to save. |
|
uBitmapID |
Id of the bitmap to save. |
|
nFormat |
Output file format. For valid values, refer to Formats of Output Files. |
|
nBitsPerPixel |
Resulting file's pixel depth. Note that not all bits per pixel are available to all file formats. For valid values, refer to Formats of Output Files. If nBitsPerPixel is 0, the file will be stored using the closet BitsPerPixel value supported by that format. For example, if a file format supports 1, 4, and 24 BitsPerPixel, and the BitsPerPixel is 5, the file will be stored as 24 bit. Likewise, if the BitsPerPixel is 2, the file will be stored as 4 bit. |
|
nQFactor |
This parameter is used when saving an image file to FILE_CMP, FILE_JFIF, FILE_LEAD1JFIF, FILE_LEAD2JFIF, FILE_JTIF, FILE_LEAD1JTIF, FILE_LEAD2JTIF, FILE_FPX_JPEG_QFACTOR, and FILE_EXIF_JPEG. Qfactor is a number that determines the degree of loss in the compression process.For possible values, refer to Compression Quality Factors. |
|
uFlags |
Binary flags that determine the behavior of save. You can specify one of the following values listed below, or set user-defined flags. |
|
|
Value |
Meaning |
|
SAVEFILE_FIXEDPALETTE |
[0x0001] The function uses the fixed palette for images that are saved as 8 bits per pixel or less. |
|
SAVEFILE_OPTIMIZEDPALETTE |
[0x0002] The function uses the individual image's optimized palette for images that are saved as 8 bits per pixel or less. The optimized palette must be included in the bitmap handle. |
|
SAVEFILE_MULTIPAGE |
[0x0004] The function saves the image in a multi-page file. It appends the image as the last one in the file. You can save multi-page images in PCX, GIF, and most TIFF file formats (including JTIF, but excluding EXIF). |
Returns
SUCCESS |
This function was successful. |
< 1 |
An occurred. Refer to Return Codes. |
Comments
The remote computer should respond by calling LInet::SendLoadRspin its LInet::CommandCallBackfunction.
With this command, the local computer will signal the remote computer to save a bitmap.
To process responses to commands, a class must be derived from LInet and the LInet::ResponseCallBackmember function must be overridden.
The LInet::CommandCallBackfunction will receive the pszFile, uBitmapID, nFormat, nBitsPerPixel, nQFactor and uFlags information in the pParams parameter. The pszFile information will be in pParams[0]. The uBitmapID information will be in pParams[1], the nFormat information will be in pParams[2], 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: |
LInet::SendSaveRsp, LInet::ResponseCallBack, LInet::CommandCallBack, Class Members |
Topics: |
|
|
Example
//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 LUserNet5 : 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, TEXT("E:\\Program Files\\LEAD Technologies\\LEADTOOLS 15\\Images\\IMAGE1.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); }; LUserNet5 m_ClientInet; L_INT LInet__SendSaveCmdExample(LInet * pInetRemoteServer, L_UINT uBitmapID) { L_INT nRet = SUCCESS; nRet = m_ClientInet.SendLoadCmd( pInetRemoteServer, 0, TEXT("c:\\temp\\remote.tif"), uBitmapID, FILE_TIF); 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 LUserNet5::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_SAVE: { //Add your code for Saving the bitmap } break; default: { return nStatus; } } } return nStatus; }