LScreenCapture::GetCaptureOption

#include "ltwrappr.h"

static L_INT LScreenCapture::GetCaptureOption(pOptions, uStructSize)

pLEADCAPTUREOPTION pOptions;	/* address of structure to be filled */
L_UINT uStructSize;	/* size in bytes, of the structure pointed to by pOptions */

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

Parameter	Description
pOptions	Pointer to the LEADCAPTUREOPTION structure to be filled with the current capture options.
uStructSize	Size in bytes, of the structure pointed to by pOptions. Use sizeof(LEADCAPTUREOPTION).

Returns

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

LTDIS
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.

Platforms

Win32, x64.

See Also

Functions:

Class Members, LScreenCapture::SetCaptureOption, LScreenCapture::SetCaptureOptionDlg

Example

L_INT LScreenCapture__GetCaptureOptionExample()
{
   L_INT nRet;
   LEADCAPTUREOPTION         CaptureOption; 
   /*Example for LScreenCapture::SetCaptureOption & LScreenCapture::GetCaptureOption
   /* get current capture options */
   nRet = LScreenCapture::GetCaptureOption(&CaptureOption, sizeof(LEADCAPTUREOPTION)); 
   if(nRet != SUCCESS)
      return nRet;
   /* change the hot key to F6 */
   CaptureOption.nHotKey = VK_F6; 
   /* set the new options */
   nRet = LScreenCapture::SetCaptureOption(&CaptureOption); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS; 
}