Skip to end of metadata
Go to start of metadata

Declaration

Delphi

procedure SetDriverLong(Key, Value: Cardinal);

C/C++

SOPAD_API void SOPAD_SetDriverLong(DWORD dwKey, DWORD dwValue);

ActiveX

HRESULT SetDriverLong([in] long Key, [in] long Value);

Description

This procedure controls the driver by setting different numerical values.

Arguments

Key

Numerical value, must be equal to one of possible values from the table (see below).

Value

Numerical value which corresponds to the Key.

Possible combinations of key and value

Possible combinations of key and value are listed int the table.

KeyValueDefault 
0Driver options 1 (read more Driver Options)DRIVER_OPTION1_TRANSPARENT_DRAW_MODE 
1Driver options 2 (read more Driver Options)0 
2Address of OnBigButton handler, same as RegisterBigButtonHandlernil 
3Address of OnSmallButton handler, same as RegisterSmallButtonHandlernil  - used by bluM and Plus-blue Pad 
4Address of OnSignFinished handlernil - used by bluM and Plus-blue Pad 
5Time in milliseconds after which OnSignFinished or OnSignFinishedEx is fired2000 
6Maximum number of tries that FastGetDeviceSettings procedure performs2 
7Address of OnBigButtonEx handlernil - used by bluM and Plus-blue Pad 
8Address of OnSmallButtonEx handlernil - used by bluM and Plus-blue Pad 
9Address of OnSignFinishedEx handlernil

stdcall

10Value of parameter passed to OnBigButtonEx handler0 
11Value of parameter passed to OnSmallButtonEx handler0 
12Value of parameter passed to OnSignFinishedEx handler0 
22Device kind filterAll devices 
23

Send command to device:

0: disable rotation button non-zero: enable rotation button

  
24

Send command to device:

0: battery discharged
non-zero: battery charged 

  
25

Send command to device:

0: rotate LCD by 0 degrees
180: rotate LCD by 180 degrees 

  
260: Obtain TabeltPC rotation angle from hardware
non-zero: Override TabletPC rotation angle
0 
27Value of overridden TabletPC rotation angle (in combination with key=26)0 
28Window handle (HWND) of the window which will be disabled when device configuration dialog is shown (in combination with key=29)0 
290: device configuration dialog doesn't affect other windows     71: RegisterOnDeviceFrameArrivedHandler(Pointer(Value));      72: RegisterOnDeviceRemovedHandler(Pointer(Value));      73: RegisterOnDeviceErrorHandler(Pointer(Value));      74: RegisterOnDevicePenEvent(Pointer(Value));
non-zero: when device configuration dialog is shown, window which handle was passed with key=28 is disabled 
0 
31Color of signature line (B-G-R) mode 0=CustomSign and 6=SignInDocBlack = 0x00000000 
36Address of OnDeviceButton handlernil 
37Value of parameter passed to OnDeviceButton or OnDeviceButtonCallback handler0 
38

Send command to device to enable or disable LCD button

high WORD: button code
low WORD: 0 to disable, non-zero to enable

    //-BUTTON TYPE

    //-naturaSign Colour LCD buttons. P = Plus, M = Minus

    HID_CMD_BUTTON_ZOOM_P         =200;   

   HID_CMD_BUTTON_ZOOM_M         =201;

    HID_CMD_BUTTON_NEXT           =202;

    HID_CMD_BUTTON_PREV           =203;

    HID_CMD_BUTTON_START_SIGN     =204;

    HID_CMD_BUTTON_ROTATE         =205;

    HID_CMD_BUTTON_OK             =206;

    HID_CMD_BUTTON_REPEAT         =207;

    HID_CMD_BUTTON_CANCEL         =208;

 

 


 

 

 
40Pass any value to destroy saved background bitmap  
44Send command to device to set brightness0-100 
45Address of OnDeviceButtonCallback handler (stdcall)  
46Allow different VendorID  
47

Set security level

0: High - only StepOver Pads with internal Encryption
1: Medium - all StepOver Pads
2: Low - all StepOver Pads + TabletPC/Wacom + OEM Pads (like XYZMO)

1 (medium) 
48

Send command to device

0: disable pen drawing
non-zero: enable pen drawing 

  
49   
50   
51   
52

PixelFormat

 is element of TPixelFormat = (pfDevice, pf1bit, pf4bit, pf8bit, pf15bit, pf16bit, pf24bit, pf32bit, pfCustom);

used in TStepOverSignatureDevice 
53FrameColorused in TStepOverSignatureDevice 
54FrameThicknessused in TStepOverSignatureDevice 
55Directly switch naturaSign mode.  
56Margin around signature which is added when cropping or stretching signature, in pixels. Affects ReadHighResBitmap, ReadHighResBitmapBase64 and ReadPreviewImage.20 
57

Saves the current rotation status Permanently for the desired degrees:

0=Landscape , Normal,

90=Potrait mode, Upside down

180=Landscape,  Upside down

270=Potrait mode, Normal

0 
58Set Pointer to Bitmap of Signing Screenlocal 
59

Filter to disable the search of mouse device

0: mouse input possible

1: mouse input disabled

1 
60

Filter to disable the search of TabletPC pens

0: pen devices will be found

1: pen devices will not be found

0 
61

Filter to disable the search of TabletPC touchs

0: touch devices will be found

1: touch devices will not be found

0 
62

Set alignment of the signature image. Affects ReadHighResBitmap, ReadHighResBitmapBase64 and ReadPreviewImage

  type TAligmentType = (alIMGCenter=0, alIMGTop = 1, alIMGBottom=2, alIMGLeft=3, alIMGRight=4);

0 
63Set the Pen width for the drawing of the Signature (internal use as radius for the anti aliasing algorithmus)

default value is 2 Pixels

Note: any number smaller than 1 is not allowed, will use radius 1 instead for Signature Pads, MSInkTablet is using value without limit.

 
64

Retrigger Refresh of Button-Bar (gen12) with mode

5 = View Document

0 = Sign

6 = Sign in Doc

  
65amount of interations for smoothing the signature imagedefault and minimum is 20! 
66

Set alignment of the preview image. used from Special Dialog XML

  type TAligmentType = (alIMGCenter=0, alIMGTop = 1, alIMGBottom=2, alIMGLeft=3, alIMGRight=4);

0 (Center by Default) 
67

Filter to disable the search of SOWIFI (smarthphone devices connected with WLAN)

0: SOWIFI devices will be found

1: SOWIFI devices will not be found

0 
68

use local WLAN-Card in PC as AccessPoint for SOWIFI

0: search first in WLAN, if not found try to use WLAN Card as local AP

1: always use WLAN Card as local AccessPoint

 0 
69

set devicekind and version for PadDimension read. To read out Pad Dimension Array we need the DeviceKind and Version of Device.

First SetDriverLong(69, (Version << 16) + Ord(DeviceKind) ); which sets the two glob Variables which are only used for Pad Dimension Array read by GetDriverLong(69); which retrieves a pointer to the corresponding Pad dimension array element. do NOT free this pointer !

  
70
set the query frequency for the button and Pen state. It is the delay for the polling thread that reads the Button state or in SIMPLE_DIALOG mode the pen state (minimum value is 10 ms)
1000 ms 
71Register for OnDevice Frame Arrived event (Address to handler function pointer)       
72Register for OnDevice Removed event (Address to handler function pointer)       
73Register for OnDevice Error event (Address to handler function pointer)       
74Register for OnDevice Pen event (Address to handler function pointer)       
75

Register for OnDevice  event handler for continuous scrolling mode (Address to handler function pointer)    

  
    

 

Sample

C#
//  Set Rotation Button
            
if(checkBox_rotation.Checked)
	SigDev.SetDriverLong(23, 1);  
else
	SigDev.SetDriverLong(23, 0);
 
            
//  Disable Drawing on the Pad, can be used to prevent that the User continues the drawing while a Signature is saved (like with AddSignature)
 
SigDev.startCapture("", true, true, true, true, ref padsetting);
...
SigDev.SetDriverLong(48, 0);	
 
SignAPIv4.AddSignature(...)
SigDev.stopRead();
  • No labels