L_InetSendLoadCmd
#include "l_bitmap.h"
#include "ltnet.h"
L_LTNET_API L_INT L_InetSendLoadCmd(hComputer, uCommandID, pszFile, nBitsPerPixel, nOrder, uFlags)
|
L_COMP hComputer; |
/* handle to a remote computer*/ |
|
L_UINT uCommandID; |
/* command id*/ |
|
L_TCHAR * pszFile; |
/* filename */ |
|
L_INT nBitsPerPixel; |
/* resulting bitmap pixel depth */ |
|
L_INT nOrder; |
/* desired color order*/ |
|
L_UINT uFlags; |
/* flags that determine function behavior */ |
Sends a load 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. |
|
|
pszFile |
Character string containing the name of the image file to load. This should be the name of a file on the computer receiving the command. |
|
|
nBitsPerPixel |
Resulting bitmap pixel depth. The following are valid values: |
|
|
|
Value |
Meaning |
|
|
0 |
Keep the original file's pixel depth (Do not convert). |
|
|
1 to 8 |
The specified bits per pixel in the resultant bitmap |
|
|
12 |
12 bits per pixel in the resultant bitmap. |
|
|
16 |
16 bits per pixel in the resultant bitmap |
|
|
24 |
24 bits per pixel in the resultant bitmap |
|
|
32 |
32 bits per pixel in the resultant bitmap |
|
|
48 |
48 bits per pixel in the resultant bitmap |
|
|
64 |
64 bits per pixel in the resultant bitmap |
|
nOrder |
Color order for 16-, 24-, 32-, 48-, and 64-bit bitmaps. If the resultant bitmap is less than 16 bits per pixel, this will have no effect since palletized images have no order. The following are valid values: |
|
|
|
Value |
Meaning |
|
|
ORDER_RGB |
[0] Red, green, and blue color order in memory |
|
|
ORDER_BGR |
[1] Blue, green, and red color order in memory |
|
|
ORDER_GRAY |
[2] 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are only supported in the Document/Medical Imaging editions . |
|
|
ORDER_RGBORGRAY |
[3] Load the image as red, green, blue OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions only. |
|
|
ORDER_BGRORGRAY |
[4] Load the image as blue, green, red OR as a 12 or 16-bit grayscale image. 12 and 16-bit grayscale images are supported in the Document/Medical Imaging editions only. |
|
uFlags |
Binary flags that determine the behavior of the loading process. You can pass some user-defined flag values, or specify one or more of the following values: |
|
|
|
Value |
Meaning |
|
|
LOADFILE_ALLOCATE |
[0x0001] The function allocates memory for the specified bitmap. (This takes place in addition to the actions of your callback function.) |
|
|
LOADFILE_STORE |
[0x0002] The function loads data into the specified bitmap. (This takes place in addition to the actions of your callback function.) |
Returns
|
SUCCESS |
This function was successful. |
|
< 1 |
An occurred. Refer to Return Codes. |
Comments
The remote computer should respond by calling L_InetSendLoadRsp in its INETCOMMANDCALLBACK function. This callback function must be set using L_InetSetCommandCallback.
With this command, the local computer will signal the remote computer to load a bitmap and send across the bitmap identifier (not the bitmap data!). The local computer can then use the bitmap identifier in other commands (like L_InetSendAttachBitmapCmd). The bitmap identifier will be sent in the response to this command.
To receive responses to commands, provide an INETRESPONSECALLBACK function. This function must be set using L_InetSetResponseCallback.
The INETCOMMANDCALLBACK function will receive the pszFile, nBitsPerPixel, nOrder and uFlags information in the pParams parameter. The pszFile information will be in pParams[0]. The nBitsPerPixel 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_InetSendLoadRsp, INETCOMMANDCALLBACK, INETRESPONSECALLBACK |
|
Topics: |
|
|
|
Example
L_INT InetSendLoadCmdExample(L_COMP hComputer,
L_TCHAR * pszFilename,
L_UINT *guCommandID)
{
return L_InetSendLoadCmd(hComputer,
*guCommandID++,
pszFilename,
0,
ORDER_BGRORGRAY,
LOADFILE_ALLOCATE | LOADFILE_STORE);
}