L_GetCaptureOption

#include "l_bitmap.h"

L_LTSCR_API L_INT L_GetCaptureOption(pOptions, uStructSize)

Gets the current options for image capture such as HotKey, Delay, and Count.

Parameters

pLEADCAPTUREOPTION pOptions

Pointer to the LEADCAPTUREOPTION structure to be filled with the current capture options.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pOptions, for versioning. Use sizeof(LEADCAPTUREOPTION).

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

Use this function to get the current image capture options. For information on the default capture options, refer to LEADCAPTUREOPTION.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT GetCaptureOptionExample(L_VOID) 
{ 
   LEADCAPTUREOPTION CaptureOption; 
 
   /* To call the L_SetCaptureOption & L_GetCaptureOption 
   /* get current capture options */ 
   memset(&CaptureOption, 0, sizeof(LEADCAPTUREOPTION)); 
 
   CaptureOption.uStructSize = sizeof(LEADCAPTUREOPTION); 
 
   L_INT nRet = L_GetCaptureOption(&CaptureOption, sizeof(LEADCAPTUREOPTION)); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* change the hot key to F6 */ 
   CaptureOption.nHotKey = VK_F6; 
 
   /* set the new options */ 
   nRet = L_SetCaptureOption(&CaptureOption); 
   return nRet; 
} 
Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Screen Capture C API Help