Breadcrumbs

signcap – Datenaustausch

Die Funktionalität der Schnittstellen unterscheidet sich teilweise; am Anfang jeder Beschreibung ist gekennzeichnet, für welche Schnittstelle die Methode oder Eigenschaft gültig ist.

Eigenschaft SignData

IPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

Enthält die digitalisierte Unterschrift im SignData-Format.

Erst verfügbar nach dem erfolgreichen Aufruf von Capture.

C#
object SignData
C++
VARIANT SignData

In

Out

mögliche Werte

Beschreibung


✔️

Bytearray

(SignData)

Daten der SignData-Struktur

Eigenschaft SignDataBase64

IPadSignotecSignatureDevice

✔️

IPadTabletPC


Enthält die digitalisierte Unterschrift als base64-kodierten String.

Erst verfügbar nach dem erfolgreichen Aufruf von Capture.

C#
string SignDataBase64
C++
BSTR SignDataBase64

In

Out

Mögliche Werte

Beschreibung


✔️

Base64-kodierter String

(SignData)

Daten der SignData-Struktur

Eigenschaft PadData

IPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

Die Nutzung der Eigenschaft wird nicht mehr empfohlen. Bitte nutzten Sie stattdessen die Eigenschaft SignData.

Für die Schnittstelle PadTabletPC enthält die Eigenschaft die Unterschriftendaten im Rohformat als eine Zeichenkette (Null-terminiert). In dem Rohformat sind unter anderem die Unterschriftenkoordinaten und die Zeitwerte für diese enthalten. Für die Schnittstelle IPadSignotecSignatureDevice enthält die Eigenschaft die SignData als Base64-kodierten String.

Erst verfügbar nach dem erfolgreichen Aufruf von Capture.

C#
object PadData
C++
VARIANT PadData

In

Out

Mögliche Werte

Beschreibung


✔️

Stringobjekt mit Wide-Char-Zeichenkette

Unterschriftendaten im Rohformat

Eigenschaft Image

IPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

Rendert die aktuelle Unterschrift als Bild (ohne biometrische Zusatzdaten). Standardmäßig ist das Bild im TIFF-Format, mit SaveSignatureEx kann aber auch ein anderes Format gewählt werden. Dazu muss SaveSignatureEx vor Capture aufgerufen werden. Je nach eingestelltem Format wird ein Bytearray oder ein String zurückgegeben.

Erst verfügbar nach dem erfolgreichen Aufruf von Capture.

Wird die Schnittstelle für Tablet PCs verwendet, wird ein globales Handle auf das Bild zurückgegeben. Nach dem Abrufen muss es mittels der Methode FreeHandle, SaveSignature oder SaveSignatureEx aus dem internen Speicher gelöscht werden. Bei letzteren beiden Methoden muss dafür der Parameter “bDeleteImage” auf true gesetzt sein.

C#
object Image
C++
VARIANT Image

In

Out

Mögliche Werte

Beschreibung


✔️

Bytearray

Unterschriftenbild

Stringobjekt mit Wide-Char-Zeichenkette

Eigenschaft PadID

IPadSignotecSignatureDevice

✔️

IPadTabletPC


Enthält die eindeutige Identifikationsnummer (ID) für das angeschlossenen Pad. Erst verfügbar nach dem erfolgreichen Aufruf von Capture.

C#
string PadID
C++
BSTR PadID

In

Out

Mögliche Werte

Beschreibung


✔️

String

Identifikationsnummer

Methode Capture

PadSignotecSignatureDevice

✔️

PadTabletPC

✔️

Mit dieser wird das Einholen der Unterschriftendaten durchgeführt. Auf der entsprechenden Hardware wird ein Unterschriftenfenster angezeigt, in dem der Benutzer unterschreiben und danach die Unterschrift bestätigen kann.

Danach kann über die entsprechenden Methoden und Eigenschaften auf die Unterschriftendaten zugegriffen werden.

Bei einem Fehler (zum Beispiel keine Hardware angeschlossen oder nicht richtig konfiguriert) oder einem Abbruch (zum Beispiel auf Benutzerwunsch oder wegen zu kurzem geleisteten Unterschriftenzug) liefert die Methode einen Fehlercode zurück (HRESULT). Bei schweren Fehlern wird der Benutzer über die Art des Fehlers mittels eines Dialogs informiert. Die Datenstrukturen für die Signatur bleiben im Fehlerfall leer.

Verschiedene Bildeigenschaften und Padeinstellungen können vor dem Aufruf dieser Methode geändert werden. Die relevanten Methoden sind hier beschrieben.

C#
void Capture();
C++
HRESULT Capture();

Rückgabewert

Beschreibung

0

Methode erfolgreich ausgeführt

-93

STPadCapt.ocx wurde nicht gefunden. (Siehe dazu den Abschnitt zur Einrichtung der Komponente.)

-94

Das konfigurierte Unterschriftenpad konnte nicht angesteuert werden

-98

Der Benutzer hat die “Überspringen”-Schaltfläche ausgewählt. Diese muss vor dem Unterschriftenprozess mit SelectDialog konfiguriert werden sein.

-99

Der Benutzer hat die Unterschriftenerfassung abgebrochen (“Abbrechen“ ausgewählt).

Methode SaveSignature

IPadSignotecSignatureDevice


IPadTabletPC

✔️

Speichert den erfassten Unterschriftenzug (entspricht der Eigenschaft Image) als Bild in die angegebene Datei.

Aufruf dieser Methode ist erst nach dem erfolgreichen Aufruf von Capture möglich.

Das gespeicherte Bild ist schwarz-weiß (1-bitig).

C#
void SaveSignature(string bstrFileName,int bDeleteImage);
C++
HRESULT SaveSignature(BSTR bstrFileName, long bDeleteImage);

Parameter


In

Out

Mögliche

Werte

Beschreibung

bstrFileName

✔️


String

Vollständiger, absoluter Pfad und Name der Datei der zu erzeugenden TIFF-Datei.

bDeleteImage

✔️


0

Das intern gespeicherte Bild wird nicht gelöscht.


1

Das intern gespeicherte Bild wird nach dem Speichern in die Datei gelöscht (entspricht einem Aufruf von FreeHandle) und steht nicht mehr zur Verfügung.

Methode SaveSignatureEx

IPadSignotecSignatureDevice

✔️

IPadTabletPC

✔️

Speichert den erfassten Unterschriftenzug (entspricht der Eigenschaft Image) als Bild in die angegebene Datei.
Der Parameter „nImgType“ definiert, in welchem Bildformat der Unterschriftenzug gespeichert werden soll.

Das Speichern mit dieser Methode ist erst nach dem erfolgreichen Aufruf von Capture möglich, kann aber für IPadSignotecSignatureDevice vor Capture zum Setzen des Bildformats aufgerufen werden.

Das gespeicherte Bild ist schwarz-weiß (1-bitig).

C#
void SaveSignatureEx(
                     string bstrFilename,
                     int nImgType,
                     int bTimeStamp,
                     int bDeleteImage
                     );
C++
HRESULT SaveSignatureEx(
                        BSTR bstrFilename,
                        int nImgType,
                        long bTimeStamp,
                        long bDeleteImage
                        );

Parameter


In

Out

Mögliche

Werte

Beschreibung

bstrFilename

✔️


String

Vollständiger, absoluter Pfad und Name der zu erzeugenden Bild-Datei

nImgType

✔️


0 - 3

Definiert in welchem Bilddateiformat der erfasste Unterschriftenzug gespeichert werden soll


0

TIFF - Faxgruppe 4


1

PNG


2

Windows Bitmap


3

Nur für IPadTabletPC: Windows Bitmap mit interpoliertem Unterschriftenzug für ein gleichmäßigeres Schriftbild

100 - 102

200 - 202

nur für IPadSignotecSignatureDevice: kein Speichern, nur Setzen von Bildformat und bTimeStamp


100

TIFF - Faxgruppe 4 als Bytearray


101

PNG als Bytearray


102

Windows Bitmap als Bytearray


200

TIFF - Faxgruppe 4 als BASE64-kodierte Zeichenkette


201

PNG als BASE64-codierte Zeichenkette


202

Windows Bitmap als BASE64-codierte Zeichenkette

bTimeStamp

✔️


0

es wird kein Zeitstempel hinzugefügt

1

ein (visueller) Zeitstempel wird unterhalb des Unterschriftenfeldes in den Unterschriftenzug gesetzt

bDeleteImage

✔️


0

Das intern gespeicherte Bild wird nicht gelöscht.

1

Nur für PadTabletPC: Das intern gespeicherte Bild wird nach dem Speichern in die Datei gelöscht (entspricht einem Aufruf von FreeHandle) und steht nicht mehr zur Verfügung.

Methode FreeHandle

IPadSignotecSignatureDevice


IPadTabletPC

✔️

Gibt das intern gespeicherte Bild der aktuellen Unterschrift frei. (Dies entspricht der Eigenschaft Image).

C#
void FreeHandle();
C++
HRESULT FreeHandle();