L_CaptureFullScreen
#include "l_bitmap.h"
L_INT L_CaptureFullScreen(pBitmap, uStructSize, pCaptureInfo, uInfoStructSize, pfnCaptureCallback, pUserData)
|
pBITMAPHANDLE pBitmap; |
/* pointer to the bitmap handle */ |
|
L_UINT uBitmapStructSize; |
/* size in bytes, of the structure pointed to by pBitmap */ |
|
pLEADCAPTUREINFO pCaptureInfo; |
/* pointer to info structure */ |
|
L_UINT uInfoStructSize; |
/* size in bytes, of the structure pointed to by pCaptureInfo */ |
|
CAPTURECALLBACK pfnCaptureCallback; |
/* optional callback function */ |
|
/* pointer to more parameters for the callback */ |
Captures an image of the entire screen.
|
Parameter |
Description |
|
pBitmap |
Pointer to a bitmap handle that references the captured data. |
|
uBitmapStructSize |
Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE). |
|
pCaptureInfo |
Address of LEADCAPTUREINFO structure to be filled with information regarding the captured image's source. Pass NULL if you are not interested in extra information about the capture. |
|
uInfoStructSize |
Size in bytes, of the structure pointed to by pCaptureInfo, for versioning. Use sizeof(LEADCAPTUREINFO). |
|
pfnCaptureCallback |
Optional callback function for additional processing. |
|
|
If you do not provide a callback function, use NULL as the value of this parameter. |
|
|
If you do provide a callback function, use the function pointer as the value of this parameter. |
|
|
The callback function must adhere to the function prototype described in CAPTURECALLBACK Function. |
|
pUserData |
Void pointer that you can use to pass one or more additional parameters that the callback function needs. |
|
|
To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID L_FAR *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. |
|
|
If the additional parameters are not needed, you can pass NULL in this parameter. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function captures an image of the entire screen. The callback can be used to do multiple captures, depending on the options set using L_SetCaptureOption.
Required DLLs and Libraries
|
LTSCR 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: |
Example
int MyMain()
{
BITMAPHANDLE Bitmap;
LEADCAPTUREINFO CaptureInfo;
/*To call the L_CaptureFullScreen*/
L_CaptureFullScreen (
&Bitmap, sizeof(BITMAPHANDLE),
&CaptureInfo, sizeof(LEADCAPTUREINFO),
pfnCaptureCallback,
NULL
);
L_FreeBitmap(&Bitmap);
return 0;
}
L_INT L_EXPORT pfnCaptureCallback (pBITMAPHANDLE pBitmap, pLEADCAPTUREINFO pCaptureInfo, L_VOID L_FAR* pUserData)
{
/* save the captured image */
return( L_SaveBitmap(TEXT("d:\\temp\\test.bmp"), pBitmap, FILE_BMP, 0, 0, NULL));
}