CIB pdf toolbox technischer Leitfaden (DE): Technische Schnittstellen

CIB pdf toolbox technischer Leitfaden (DE)

12. Technische Schnittstellen

Dieses Kapitel gibt einen kurzen Überblick über die verfügbare API und derer Parameter. Allgemein gilt, daß man über die Funktion CibPdfSetProperty seine gewünschten Parameter in die CIB pdf toolbox setzt und dann eine Funktion CibPdfJoin oder CibPdfMerge aufruft.

CibPdfSetProperty
CibPdfGetProperty
CibPdfJoin
CibPdfMerge
CibPdfGetVersion
CibPdfGetError
CibPdfGetErrorText
CibPdfGetLastError
CibPdfGetLastErrorText
CibPdfEventNotifier
CibPDFshowPageSetupDialog
CibPdfShowPrintDialog
CibPdfShowPrintSetupDialog
MemoryOutputCallback
AbortDocCallback
CibPdfJobCreate
CibPdfJobFree
CibPdfJobMerge
CibPdfJobJoin
CibPdfJobShowPrintDialog
CibPdfJobShowPrintSetupDialog
CibPdfJobShowPageSetupDialog
CibPdfJobGetProperty
CibPdfJobSetProperty
CibPdfJobGetPropertyW
CibPdfJobSetPropertyW
CibPdfJobGetError
CibPdfJobGetErrorText
CibPdfJobCancel

CibPdfSetProperty

BOOL EXPORTFUNC CibPdfSetProperty (const char* a_pOptionName,

void* a_pOptionValue)

Mit dieser Funktion werden Eigenschaften für die CIB pdf toolbox gesetzt. Die Eigenschaften InputFilename, OutputFilename sowie Data müssen vor Aufruf von CibPdfMerge gesetzt werden. Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

Parameter:

Typ	Variable	Bedeutung
char*	a_pOptionName	Name des gewünschten Konfigurationsparameters
void*	a_pOptionValue	Wert des gewünschten Konfigurationsparameters
		Achtung: Beachten Sie den Datentyp des jeweiligen Wertes

CibPdfGetProperty

BOOL EXPORTFUNC CibPdfGetProperty(const char* a_pOptionName,

void* a_pOptionValue, long a_lBufferLength)

Mit dieser Funktion können die aktuell gesetzten Eigenschaften der CIB pdf toolbox Komponente abgefragt werden. Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

Parameter:

Typ	Variable	Bedeutung
char*	a_pOptionName	Name des gewünschten Konfigurationsparameters
void*	a_pOptionValue	Wert des gewünschten Konfigurationsparameters
long	a_lBufferLength	Länge des Puffers für den Optionsinhalt

CibPdfJoin

BOOL EXPORTFUNC CibPdfJoin()

Mit dieser Methode wird die Join Funktionalität gestartet. Mit der Funktion CibPdfSetProperty müssen vorher mindestens die Eigenschaften InputFilename und OutputFilename gesetzt werden. Beim Aneinanderfügen von verschlüsselten Pdfs muss für jede Datei das zugehörige Ownerpaßwort bekanntgegeben werden. Dies geschieht mittels der Property EncryptOwnerPassword. Die Funktion hat keine Parameter. Sie liefert TRUE wenn kein Fehler beim Ausführen dieser Funktion aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfMerge

BOOL EXPORTFUNC CibPdfMerge()

Mit dieser Methode wird der Merge-Durchlauf gestartet. Mit der Funktion CibPdfSetProperty müssen vorher mindestens die Eigenschaften InputFilename, OutputFilename und Data gesetzt werden. Die Funktion hat keine Parameter. Sie liefert TRUE wenn kein Fehler beim Ausführen dieser Funktion aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfGetVersion

BOOL EXPORTFUNC CibPdfGetVersion(unsigned long *a_iVersion)

Die Funktion liefert die aktuelle Versionsnummer der Cib pdfm Komponente zurück. Damit können Sie in Ihrer Applikation sicherstellen, daß eine Mindestversion vorliegt, wenn Sie etwa spezielle Programmeigenschaften benutzen, die erst ab einem bestimmten Release zur Verfügung gestellt wurden. Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

Parameter:

Typ	Variable	Bedeutung
unsigned long &	a_lVersion	a_lVersion liefert die aktuelle Versionsnummer der CIB pdfm Komponente zurück. Der unsigned long-Wert liefert die Informationen in zwei Bereichen. Die ersten zwei Bytes enthalten den Versionszähler des Hauptreleases. Die Bytes 3 und 4 enthalten den zugehörigen aktuellen Releasezähler. Je nach Programmiersprache sind die Hi- und Lowbereiche entsprechend zu beachten (siehe Schneller Einstieg).

CibPdfGetError

BOOL EXPORTFUNC CibPdfGetError (CibPdfHandle a_hJob, int*a_pErrorCode)

Mit dieser Funktion kann der aktuelle Fehlertext zu einem Auftrag nach dem Ausführen einer Funktion abgefragt werden.

Parameter:

Typ	Variable	Bedeutung
long	a_hJob	Handle des auszuführenden Auftrags
int *	a_iError	Platzhalter für die aktuelle Fehlernummer

CibPdfGetErrorText

BOOL EXPORTFUNC CibPdfGetErrorText(int a_iErrorId, char* a_pTextBuffer,

long a_lBufferLength)

Mit dieser Funktion kann der aktuelle Fehlertext zu einem Auftrag nach dem Ausführen einer Funktion abgefragt werden. Die Funktion liefert TRUE wenn kein Fehler beim Abholen des Fehlertextes aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

Parameter:

Typ	Variable	Bedeutung
int	a_iErrorId	Fehlernummer
char	a_pTextBuffer	Textpuffer für den Fehlertext
long	a_lBufferLength	Länge des verfügbaren Textpuffers

CibPdfGetLastError

BOOL EXPORTFUNC CibPdfGetLastError(int *a_iError)

Mit dieser Funktion kann der aktuelle Fehlerstatus der CIB pdf Komponente nach dem Ausführen verschiedener Funktionen abgefragt werden. Die Funktion liefert TRUE wenn kein Fehler beim Ausführen dieser Funktion aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

Parameter:

Typ	Variable	Bedeutung
int	a_iError	Platzhalter für die aktuelle Fehlernummer

CibPdfGetLastErrorText

BOOL EXPORTFUNC CibPdfGetLastErrorText(char* a_pTextBuffer,

long a_lBufferLength)

Mit dieser Funktion kann der aktuelle Fehlertext der CIB pdf toolbox Komponente nach dem Ausführen einer Funktion abgefragt werden. Die Funktion liefert TRUE wenn kein Fehler beim Abholen des Fehlertextes aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

Parameter:

Typ	Variable	Bedeutung
int	a_pTextBuffer	Textpuffer für den Fehlertext
long	a_lBufferLength	Länge des verfügbaren Textpuffers

CibPdfEventNotifier

(ab CIB pdf toolbox Version 1.24.0)

Um die Verwendung der Callbacks zu ermöglichen muss in der rufenden Anwendung zu der in „CibPdfEventNotifier.h“ der CIB pdf toolbox definierten CibPdfEventNotifier Klasse eine abgeleitete Klasse implementiert werden.

Ebenso müssen deren abstrakte Methoden
CibPdfEventNotifier::OnPageStart(...) und
CibPdfEventNotifier::OnPageImageOutput(...),
implementiert werden um die Callback-Daten empfangen zu können.

Der Pointer zu der Instanz der abgeleiteten Klasse wird (konvertiert in eine natürliche Zahl und als String dargestellt) der Property “EventNotifier” zugeordnet.

Die Methode „CibPdfEventNotifier::OnPageStart(...)“ wird von der CIB pdf toolbox zu Beginn der Verarbeitung jeder Seite gerufen. Sie liefert die „CibPdfEventPageInfo“-Datenstruktur und ein Kennzeichen zurück, über das die weitere Verarbeitung abgebrochen werden kann.

Die Methode „CibPdfEventNotifier::OnPageImageOutput(...)“ wird von der CIB pdf toolbox nach dem Rendern einer Seite und vor dem Speichern des Bildes gerufen. Sie liefert die „CibPdfEventPageImageInfo“-Datenstruktur und ein Kennzeichen zurück, über das das Speichern des Bildes verhindert werden kann.

class CibPdfEventNotifier
{
public:
   virtual void OnPageStart(CibPdfEventPageInfo* pageInfo, bool& abort) = 0;
   virtual void OnPageImageOutput(CibPdfEventPageImageInfo* imageInfo, bool&
   skipFileOutput) = 0;
};

CibPdfEventPageInfo

Die von der CIB pdf toolbox zu Beginn der Verarbeitung jeder Seite gelieferte „CibPdfEventPageInfo“-Datenstruktur hat den folgenden Aufbau:

struct CibPdfEventPageInfo
{
int pageIndex;
size_t pageWidth;
size_t pageHeight;
};

Parameter:

Typ	Variable	Bedeutung
int	pageIndex	Index der aktuellen Seite (0-basiert)
size_t	pageWidth pageHeight	Breite und Höhe der aktuellen Seite in Pixel und der Standard-Auflösung von 72dpi

CibPdfEventPageImageInfo

Die von der CIB pdf toolbox nach dem Rendern einer Seite und vor dem Speichern des Bildes gelieferte „CibPdfEventPageImageInfo“-Datenstruktur hat den folgenden Aufbau:

struct CibPdfEventPageImageInfo
{
int pageIndex;
size_t imageWidth;
size_t imageHeight;
size_t imageStride;
size_t imageLength;
Format imageFormat; 
const unsigned char* data;
};
enum Format {fRGB565, fRGB888, fBMP};

Parameter:

Typ	Variable	Bedeutung
int	pageIndex	Index der aktuellen Seite (0-basiert)
size_t	imageWidth imageHeight imageStride	Die Standard-Parameter einer Bitmap im DIB-format (DIB = geräteunabhängiges Bitmap Format)
char*	Data	Komplette Bitmap im DIB-Format
size_t	imageLength	Deren Länge in Bytes

CibPDFshowPageSetupDialog

(ab CIB pdf toolbox Version 1.10.0)

BOOL EXPORTFUNC CibPdfShowPageSetupDialog(int *a_iButtonID);

Unter Windows startet diese Funktion mit dem Standard Druckertreiberdialog vom Betriebssystem. Hierüber können entsprechende Druckerkonfigurationen getroffen werden, die beim anschließenden Drucken berücksichtigt werden. Diese Funktion ist für Anwendungen interessant, die den Druck immer mit einem Benutzerdialog ausführen wollen.

Parameter:

Typ	Variable	Bedeutung
int*	a_iButtonId	Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde. 1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden) 3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken) 2 (CIB_ID_CANCEL) Abbrechen-Button

Typ

Variable

Bedeutung

int*

a_iButtonId

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL) Abbrechen-Button

Die Funktion liefert TRUE zurück wenn kein Fehler aufgetreten ist.

CibPdfShowPrintDialog

BOOL EXPORTFUNC CibPdfShowPrintDialog(int *a_iButtonID);

Unter Windows startet diese Funktion mit dem Standard Seitenauswahl-/Druckertreiberdialog vom Betriebssystem. Hierüber können entsprechende Druckerkonfigurationen und Seitenauswahlen getroffen werden, die beim anschließenden Drucken berücksichtigt werden. Diese Funktion ist für Anwendungen interessant, die den Druck immer mit einem Benutzerdialog ausführen wollen.

Parameter:

Typ	Variable	Bedeutung
int*	a_iButtonId	Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde. CIB_ID_OK OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden) CIB_ID_CLOSE Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken) CIB_ID_CANCEL Abbrechen-Button

Typ

Variable

Bedeutung

int*

a_iButtonId

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

CIB_ID_OK OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

CIB_ID_CLOSE Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

CIB_ID_CANCEL Abbrechen-Button

Die Funktion liefert TRUE zurück wenn kein Fehler aufgetreten ist.

CibPdfShowPrintSetupDialog

(ab CIB pdf toolbox Version 1.10.0)

BOOL EXPORTFUNC CibPdfShowPrintSetupDialog(int *a_iButtonID);

Unter Windows startet diese Funktion mit dem Standard Seitenauswahl-/Druckertreiberdialog vom Betriebssystem. Hierüber können entsprechende Druckerkonfigurationen getroffen werden, die beim anschließenden Drucken berücksichtigt werden. Diese Funktion ist für Anwendungen interessant, die den Druck immer mit einem Benutzerdialog ausführen wollen.

Parameter:

Typ	Variable	Bedeutung
int*	a_iButtonId	Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde. CIB_ID_OK OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden) CIB_ID_CLOSE Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken) CIB_ID_CANCEL Abbrechen-Button

Typ

Variable

Bedeutung

int*

a_iButtonId

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

CIB_ID_OK OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

CIB_ID_CLOSE Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

CIB_ID_CANCEL Abbrechen-Button

Die Funktion liefert TRUE zurück wenn kein Fehler aufgetreten ist.

MemoryOutputCallback

COMOD_CALLBACK_TYPE(COMOD_BOOL, MemoryOutputCallbackType) (const char* a_TextOutput, size_t a_Length, void*a_pUserdata, int a_Error)

Callback-Prototyp für Daten-Ausgabe im Speicher.

Parameter:

Typ	Variable	Bedeutung
char*	a_TextOutput	Die Daten, die über die Callbackfunktion übergeben werden.
size_t	a_Length	Die Byte-Anzahl der Daten.
void*	a_pUserdata	Zeiger auf beliebige Nutzerdaten. Konkreter Typ hängt von der Implementierung der Callbackfunktion ab.
Int*	a_Error	Fehlercode, der vom Aufrufer an die Callbackfunktion übergeben wird.

Die Funktion liefert FALSE zurück wenn Fehler aufgetreten ist.

AbortDocCallback

(ab CIB pdf toolbox Version 1.10.0)

BOOL EXPORTFUNC AbortDocCallback(const ABORTDOCINFO* a_AbortDocInfo, void* a_pUserData)

typedef struct _abortdoc {unsigned long ulCurrentPage;unsigned long ulPageCount;} ABORTDOCINFO;

Callback-Prototyp für Daten-Ausgabe im Speicher. Die Callback wird nach jeder Seite des Dokumentes mit den Informationen zur aktuellen Seitenzahl und der Gesamtseitenzahl aufgerufen. Durch Rückgabe des Wertes „true“ wird die Konvertierung fortgesetzt, durch false erfolgt ein Abbruch der Konvertierung mit Rückgabewert 1000(userbreak).

Parameter:

Typ	Variable	Bedeutung
ABORTDOCINFO*	a_AbortDocInfo	Die Daten, die über die Callbackfunktion übergeben werden.
void*	a_pUserdata	Zeiger auf beliebige Nutzerdaten. Konkreter Typ hängt von der Implementierung der Callbackfunktion ab.

Die Funktion liefert FALSE zurück wenn ein Abbruch gewünscht ist.

CibPdfJobCreate

COMOD_BOOL COMOD_API CibPdfJobCreate(CibPdfJobHandle*a_pJob, const char* a_pReserved)

Mit dieser Methode wird ein JobHandle erzeugt, welches dann mit Hilfe von CibPdfJobFree wieder freigegeben wird.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_pJob	Handle des auszuführenden Auftrags
char*	a_pReserved

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobFree

COMOD_BOOL COMOD_API CibPdfJobFree(CibPdfJobHandle*a_pJob);

Mit dieser Methode wird ein, mit Hilfe von CibPdfJobCreate erzeugtes JobHandle wieder freigegeben.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_pJob	Handle des freizugebenden Auftrags

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobMerge

COMOD_BOOL COMOD_API CibPdfJobMerge(CibPdfJobHandle a_hJob);

Mit dieser Methode wird ein PDF-Merge Job ausgeführt. Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobJoin

COMOD_BOOL COMOD_API CibPdfJobJoin(CibPdfJobHandle a_hJob);

Mit dieser Methode wird ein PDF-Join Job ausgeführt. Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobShowPrintDialog

COMOD_BOOL COMOD_API CibPdfJobShowPrintDialog(CibPdfJobHandle a_hJob, int* a_pButtonID);

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
Int*	a_pButtonID	Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde. 1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden) 3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken) 2 (CIB_ID_CANCEL) Abbrechen-Button

Typ

Variable

Bedeutung

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

Int*

a_pButtonID

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL) Abbrechen-Button

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobShowPrintSetupDialog

COMOD_BOOL COMOD_API CibPdfJobShowPrintSetupDialog(CibPdfJobHandle a_hJob, int* a_pButtonID);

Unter Windows startet diese Funktion mit dem Druckereigenschaftendialog des jeweiligen Treiberherstellers des gerade aktivierten Druckers. Hierüber können entsprechende Druckerkonfigurationen getroffen werden, die beim anschließenden Drucken berücksichtigt werden. Diese Funktion ist für Anwendungen interessant, die den Druck immer mit einem Benutzerdialog ausführen wollen.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
Int*	a_pButtonID	Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde. 1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden) 3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken) 2 (CIB_ID_CANCEL) Abbrechen-Button

Typ

Variable

Bedeutung

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

Int*

a_pButtonID

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL) Abbrechen-Button

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobShowPageSetupDialog

COMOD_BOOL COMOD_API CibPdfJobShowPageSetupDialog(CibPdfJobHandle a_hJob, int* a_pButtonID);

Unter Windows startet diese Funktion mit dem Standard Druckertreiberdialog vom Betriebssystem. Hierüber können entsprechende Druckerkonfigurationen (Seite einrichten) getroffen werden, die beim anschließenden Drucken berücksichtigt werden. Diese Funktion ist für Anwendungen interessant, die den Druck immer mit einem Benutzerdialog ausführen wollen.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
Int*	a_pButtonID	Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde. 1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden) 3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken) 2 (CIB_ID_CANCEL) Abbrechen-Button

Typ

Variable

Bedeutung

CibPdfJobHandle*

a_hJob

Handle des auszuführenden Auftrags

Int*

a_pButtonID

Rückgabe der ButtonId die innerhalb der Druckauswahl gedrückt wurde.

1 (COMOD_ID_OK) OK-Button (=> es sollte von Ihnen CibPrPrint im Anschluß aufgerufen werden)

3 (COMOD_ID_CLOSE) Schließen-Button (=> der Anwender hat den Drucker gewechselt möchte aber nicht sofort drucken)

2 (CIB_ID_CANCEL) Abbrechen-Button

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobGetProperty

COMOD_BOOL COMOD_API CibPdfJobGetProperty(CibPdfJobHandle a_hJob, const char* a_pName, void*a_pValue, size_t a_MaxLength);

Mit dieser Funktion können die aktuell gesetzten Eigenschaften der CIB pdf toolbox Komponente abgefragt werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
char*	a_pName	Name der gewünschten Property
void*	a_pValue	Wert der gewünschten Property
size_t	a_MaxLength	Länge des Puffers für den Optionsinhalt

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobSetProperty

COMOD_BOOL COMOD_API CibPdfJobSetProperty(CibPdfJobHandle a_hJob, const char* a_pName, void*a_pValue, size_t a_Length);

Mit dieser Funktion können die Properties für die Ausführung der CIB pdf toolbox Komponente gesetzt werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
char*	a_pName	Name der gewünschten Property
void*	a_pValue	Wert der gewünschten Property
size_t	a_Length

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobGetPropertyW

COMOD_BOOL COMOD_API CibPdfJobGetPropertyW(CibPdfJobHandle a_hJob, const wchar_t* a_pName, const wchar_t*a_pValue, size_t a_MaxLength);

Mit dieser Funktion können die aktuell gesetzten Eigenschaften der CIB pdf toolbox Komponente abgefragt werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
wchar-t*	a_pName	Name der Property in wchar_t* (UNICODE)
wchar-t*	a_pValue	Wert der Property in wchar_t* (UNICODE)
size_t	a_MaxLength	Die Byte-Anzahl der Daten

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobSetPropertyW

COMOD_BOOL COMOD_API CibPdfJobSetPropertyW(CibPdfJobHandle a_hJob, const wchar_t* a_pName, const wchar_t*a_pValue/*, size_t a_Length*/);

Mit dieser Funktion können die Properties für die Ausführung der CIB pdf toolbox Komponente gesetzt werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
wchar-t*	a_pName	Name der Property in wchar_t* (UNICODE)
wchar-t*	a_pValue	Wert der Property in wchar_t* (UNICODE)
size_t	a_MaxLength	Die Byte-Anzahl der Daten

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobGetError

COMOD_BOOL COMOD_API CibPdfJobGetError(CibPdfJobHandle a_hJob, int*a_pErrorCode);

Mit dieser Funktion kann der aktuelle Fehlerstatus der CIB pdf toolbox nach dem Ausführen verschiedener Funktionen abgefragt werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
int*	a_pErrorCode	Platzhalter für die aktuelle Fehlernummer

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobGetErrorText

COMOD_BOOL COMOD_API CibPdfJobGetErrorText(CibPdfJobHandle a_hJob, char* a_pText, size_t a_MaxLength);

Mit dieser Funktion kann der aktuelle Fehlertext zu einem Auftrag nach dem Ausführen einer Funktion abgefragt werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags
char*	a_pText	Textpuffer für den Fehlertext
size_t	a_MaxLength	Länge des verfügbaren Textpuffers

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.

CibPdfJobCancel

(ab CIB pdf toolbox Version 1.24.0)

COMOD_BOOL COMOD_API CibPdfJobCancel(CibPdfJobHandle a_hJob);

Mit dieser Funktion kann der aktuelle Auftrag einer CIB ocr Texterkennung (CibOcrJobGetProgress) abgebrochen werden.
Das JobHandle muss vorher mit CibPdfJobCreate erzeugt worden sein.

Parameter:

Typ	Variable	Bedeutung
CibPdfJobHandle*	a_hJob	Handle des auszuführenden Auftrags

Die Funktion liefert TRUE wenn kein Fehler aufgetreten ist. Ansonsten wird FALSE zurückgegeben.