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.

Key	Value	Default
0	Driver options 1 (read more Driver Options)	DRIVER_OPTION1_TRANSPARENT_DRAW_MODE
1	Driver options 2 (read more Driver Options)	0
2	Address of OnBigButton handler, same as RegisterBigButtonHandler	nil
3	Address of OnSmallButton handler, same as RegisterSmallButtonHandler	nil - used by bluM and Plus-blue Pad
4	Address of OnSignFinished handler	nil - used by bluM and Plus-blue Pad
5	Time in milliseconds after which OnSignFinished or OnSignFinishedEx is fired	2000
6	Maximum number of tries that FastGetDeviceSettings procedure performs	2
7	Address of OnBigButtonEx handler	nil - used by bluM and Plus-blue Pad
8	Address of OnSmallButtonEx handler	nil - used by bluM and Plus-blue Pad
9	Address of OnSignFinishedEx handler	nil	stdcall
10	Value of parameter passed to OnBigButtonEx handler	0
11	Value of parameter passed to OnSmallButtonEx handler	0
12	Value of parameter passed to OnSignFinishedEx handler	0
22	add Device kind to internal filter. if Value is 0 = dkNoDevice the internal List is erased if Value is > 0 then the corresponding device kind is added to the internal list. dkNoDevice, // 00: dkStepOver, // 01: dkTabletPC, // 02: wintabPIDval = 1 dkInterlink, // 03: wintabPIDval = 2 dkWintab, // 04: wintabPIDval = 3 dkTopaz, // 05: wintabPIDval = 4 dkNaturaSignV1, // 06: G5 dkSmartPhone, // 07: dkMsInkTabletPC, // 08: dkNaturaSignV3, // 09: G5 dkNaturaSignColour, // 10: g6 dkNaturaSignColourM, // 11: G6 dkNaturaSignColourM2, // 12: G6 dkNaturaSignMobile, // 13: g7 dkNaturaSignFlawless, // 14: g8 dkNaturaSignComfort, // 15: g8 dkNaturaSignClassic, // 16: g9 dkNaturaSignBiometric, // 17: g9 dkNaturaSignMobile15, // 18: g10 dkNaturaSignColorPad2, // 19: g6 (g11 ?) dkDuraSignUniversal, // 20: g12 dkDuraSignBrilliance, // 21: g12 dkDuraSignBiometric, // 22: g12 dkNaturaSignColourBiometric,// 23: g6 ? dkNaturaSignMobileBiometric,// 24: g7 ? dkDuraSignGen13Standard, //25: g13 dkDuraSignGen13Biometric, //26: g13 dkDuraSignGen13GemSign10, //27:g13 (topaz) dkDuraSignMobile //28:g15	All 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
26	0: Obtain TabeltPC rotation angle from hardware non-zero: Override TabletPC rotation angle	0
27	Value of overridden TabletPC rotation angle (in combination with key=26)	0
28	Window handle (HWND) of the window which will be disabled when device configuration dialog is shown (in combination with key=29)	0
29	0: 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
31	Color of signature line (B-G-R) mode 0=CustomSign and 6=SignInDoc	Black = 0x00000000
36	Address of OnDeviceButton handler	nil
37	Value of parameter passed to OnDeviceButton or OnDeviceButtonCallback handler	0
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;
40	Pass any value to destroy saved background bitmap
44	Send command to device to set brightness	0-100
45	Address of OnDeviceButtonCallback handler (stdcall)
46	Allow 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
53	FrameColor	used in TStepOverSignatureDevice
54	FrameThickness	used in TStepOverSignatureDevice
55	Directly switch naturaSign mode.
56	Margin 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
58	Set Pointer to Bitmap of Signing Screen	local
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
63	Set 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
65	amount of interations for smoothing the signature image default value= 2 minimum value = 2	default 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 for mobile devices is active for the connected network(s). Additionally the user has the option to open a Hotspot from inside the device search dialog 1: search for mobile devices is active for the connected network(s). This option disables the HotSpot button inside the device search dialog 2: HotSpot is automatically created when Pad Search is triggered, the search for devices will be reduce to the Hotspot network 3: start Hotspot 4: stop Hotspot ( the hotspot will automatically stop with Finalize of the deviceAPI)	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
71	Register for OnDevice Frame Arrived event (Address to handler function pointer)
72	Register for OnDevice Removed event (Address to handler function pointer)
73	Register for OnDevice Error event (Address to handler function pointer)
74	Register for OnDevice Pen event (Address to handler function pointer)
75	Register for OnDevice event handler for continuous scrolling mode (Address to handler function pointer)
76	set current cryptoID index - used in CryptoID container V2
77	set the DPI for the final Signature Image (default 300) - has only effect on biometric pads and for drawing the final signature image
78	set if NextGen device usage is allowed. default value is YES
79	set current Document Identifier. Note: the document Id is generated internal if the value < 1000000.

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();