L_GetCaptureOption

Summary

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

Syntax

L_LTSCR_API L_INT L_GetCaptureOption(pOptions, uStructSize)

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

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

• 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

• L_SetCaptureOption
• L_SetCaptureOptionDlg

Topics

• Screen Capture C API Function Groups: Getting Information Functions
• Implementing Screen Capture

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; 
}