API

Site: CIB eLearning
Course: CIB pdf brewer
Book: API
Printed by: Guest user
Date: Saturday, 28 January 2023, 1:13 AM

Full list of API settings

SettingDefaultTypeDescription
Author
stringSets PDF document information, author
CenterWindowfalseboolOpens PDF viewer centered if enabled, default value will be used otherwise
CertificateFile
stringCertificate file
CertificatePassword
stringPassword of the certificate file
CertificatePasswordSetDuringCreationfalseboolAsk for password when creating output file
Colorspace0enumOptions: RGB (0), CMYK (1)
ComparableModefalseboolTIFF comparable mode
CompressionFineTunefalseboolSet enable to allow UI manual tweaking of compression features.
CompressionPredefined1intDefault compression profile. Use CompressionProfile to change compression settings
CompressionProfile3enumOptions: CompressionNormal (0), CompressionHigher (1), CompressionHighest (2), LossLessJPEG (3), LosslessZIP (4)
CoverFilesList
arrayString list of cover documents
CoverFilesListEnabledfalseboolIf enabled, CoverFilesList are used
DestinationDirectory
stringOutput directory
DestinationFilename<Documentname>.pdfstringOutput filename
DestinationFilenameSuffix
stringFile name suffix
DestinationFilenameSuffixEnabledfalseboolIf enabled, file name suffix is used
DictionaryWorkSpacedictstringDictionary workspace
Direction0enumL2R (0), R2L(1)
DisplayDocTitlefalseboolDisplay document title in PDF viewer
EmbedFilenamesEnabledtrueboolEnable the embedding of files defined in EmbeddedFilesList
EmbeddedFilesList
arrayArray of files to be embedded in the output PDF
EncryptAskForPasswordEnabledfalseboolAsk for password in UI saving workflow
EncryptEnableAssemblingfalseboolEncryption permissions
EncryptEnableClipboardfalseboolEncryption permissions
EncryptEnableExtractfalseboolEncryption permissions
EncryptEnableFormsfalseboolEncryption permissions
EncryptEnableModifyingfalseboolEncryption permissions
EncryptEnableNotesfalseboolEncryption permissions
EncryptEnablePrintingfalseboolEncryption permissions
EncryptEnhancedPdfPassword
string-
EncryptOwnerPassword
stringPDF owner password
EncryptOwnerPasswordEnabledfalseboolUse owner password
EncryptPasswordsConfirmedfalsebool-
EncryptUserPassword
stringPDF user password
EncryptUserPasswordEnabledfalseboolUse user password
ExecuteProgramAction
arrayArray of ProgramAction objects: {"Program": "...", "Arguments": "..."}
FatturaPADestinationCode0stringFatturaPA destination code setting
FatturaPAPECDestinatario
stringFatturaPA recipient setting
FatturaPARecipientIsGovernmentfalseboolFatturaPA recipient is Government setting
FileExistsAction0enumOptions: save_to_auto_destination (0), replace (1), append (2), prepend (3)
FileQuerytrueboolAsk for file
FitWindowfalseboolPDF viewer setting, fit document to window
FontAntialiasing2enumOptions: Off (0), On (1), Default (2)
FontsEmbedded0enumOptions: none (0), all (1), selected (2), nostandard (3)
FontsEmbeddedOrNoEmbeddedList
stringSemicolon separated string of fonts that are not going to be embedded in the PDF
FontsIsEmbeddedOrNoEmbeddedListfalseboolEnables the usage of FontsEmbeddedOrNoEmbeddedList
FooterFilesList
arrayString list of footer documents
FooterFilesListEnabledfalseboolIf enabled, FooterFilesList are used
ForcePaperLength297intPaper height
ForcePaperSize0enumOptions: None (0), Letter 8 1/2 x 11 inch (1), Legal 8 1/2 x 14 inch (5), Executive 7 1/4 x 10 1/2 inch (7), A0 841 x 1189 mm (255), A1 594 x 841 mm (254), A3 297 x 420 mm (8), A2 420 x 594 mm (66), A3 Extra Traverse 322 x 455 mm (68), A4 210 x 297 mm (9), A5 148 x 210 mm (11), A6 105 x 148 mm (70), B4 250 x 354 mm (12), B4 182 x 257 mm (13), User defined (256)
ForcePaperWidth210intPaper width
FormfieldCheckboxBackColor12632256intCheckbox background color
FormfieldCheckboxBorderColor0intCheckbox border color
FormfieldDropdownBackColor12632256intDropdown background color
FormfieldDropdownBorderColor0intDropdown border color
FormfieldInternalCharCount1intChar count
FormfieldTextfieldBackColor12632256intTextfield background color
FormfieldTextfieldBorderColor0intTextfield border color
FormfieldUseAutoTextHeightfalseboolUse automatic height
FormfieldUseCheckboxBackColortrueboolUse the previously defined checkbox background color
FormfieldUseCheckboxBordertrueboolUse the previously defined checkbox border color
FormfieldUseDefaultTextMaxCharstrueboolUse the default max. number of characters
FormfieldUseDefaultTextWidthtrueboolUse the default text width
FormfieldUseDropdownBackColortrueboolUse the previously defined dropdown background color
FormfieldUseDropdownBorderfalseboolUse the previously defined border color
FormfieldUseInternalCharCountfalsebool
FormfieldUseInternalCharCountMaxCharsfalsebool
FormfieldUseTextfieldBackColortrueboolUse the previously defined textfield background color
FormfieldUseTextfieldBorderfalseboolUse the previously defined border color
GraphicColorReduction0enumOptions: None (0), Automatic (1)
GraphicCompressMethod0enumOptions: None (0), AutomaticJPEG (1), AutomaticZlibJPEG (2), JPEG (3), ZlibJPEG (4)
GraphicJpegQuality75intJPEG quality
GraphicResolution600intTarget resolution for graphics.
HideMenubarfalseboolPDF viewer hide menubar
HideToolbarfalseboolPDF viewer hide toolbar
HideWindowUIfalseboolPDF viewer hide window UI
HybridOutputEnabled0enumOptions: Hybrid_disabled (0), Hybrid_enabled (1), Hybrid_ask (100)
HybridPdfSourceFilename
string
HybridPdfSourceFilenameUsed
string
HybridResourceSharingEnabledtruebool
HyperlinkBorder1enumOptions: None (0), Underlined (1), Frame (2), DashedFrame (3), DottedFrame (4)
HyperlinkBorderColor0int
HyperlinkBorderWidth100int
InvoiceType1enumOptions: zugferd1 (0), zugferd2 (1), xrechnung (2), fatturapa (3)
Keywords
string
MailBCCRecipient
string
MailCCRecipient
string
MailNotetext
string
MailRecipient
string
MailSendImmediatefalsebool
MailSubject
string
MailText
string
NonFullScreenPageMode0enumOptions: UseNone (0), UseOutlines (1), UseThumbs (2), UseOC (3), UseAttachments (4)
OpenLayout0enumOptions: SinglePage (0), OneColumn (1), TwoColumnLeft (2), TwoColumnRight (3), TwoPageLeft (4), TwoPageRight (5)
OpenMode0enumOptions: UseNone (0), UseOutlines (1), UseThumbs (2), FullScreen(3)
OpenPageIndex0int
OpenSize0enumOptions: Standard (0), Fit (1), FitH (2)
OutlineFormats{STYLE: heading 1...string
OutlineStylesheading 1string
OutlineStylesEnabledfalsebool
PageOrientation1enumOptions: portrait (1), landscape (2)
PaperBorder0enumOptions: 0 pt (0), j pt (25), S pt (50), s pt (75), 1 pt (100), 1S pt (150), 2j pt (225), 3 pt (300), 4S pt (450), 6 pt (600)
PaperMarginCentertruebool
PaperMarginLeft0int
PaperMarginTop0int
PaperScaleHeight100int
PaperScaleWidth100int
PdfVersion20enumOptions: PDF1_3 (13), PDF1_4 (14), PDF1_5 (15), PDF1_6 (16), PDF1_7 (17), PDF1_7EL3 (18), PDF1_7EL8 (19), PDF2_0 (20), PDFA_1a (100), PDFA_1b (101), PDFA_2a (102), PDFA_2b (103), PDFA_2u (104), PDFA_3a (105), PDFA_3b (106), PDFA_3u (107), PDFUA (200)
PrintDuplexType0enumOptions: simple (0), duplexshort (1), duplexlong (2)
PrintTargetPrinter
string
PrintType0enumOptions: printerdefault (0), printerdialog (1), printerselected (2)
SaveConversion0enumOptions: printer (0), rtf (1)
SaveLocation1enumOptions: last (0), documents (1), predefined (2), desktop (3)
ShowFormfieldsfalsebool
SignContactInfo
string
SignLocation
string
SignReason
string
StampEnabledfalsebool
StampSelected
string
StartAction1int
StartProgram
string
StartProgramBefore
string
StartProgramParameters
string
StartProgramParametersBefore
string
StationeryEnabledfalsebool
StationeryUsed
string
Subject
string
TiffColorDepth1enumOptions: Depth24 (0), Depth1 (1), Depth4 (4), Depth8 (2), Depth8Gray (3)
TiffCompress2enumOptions: None (0), Group3 (1), Group4 (2), RLE (3), LZW (4), Jpeg (5), Packbits (6), Deflate (7)
TiffJpegQuality75int
TiffResolution150int
TiffStripSize4int
Title
string
UseEncryptEnhancedPdfPasswordfalsebool
UseHyperlinkRecognitionfalsebool
UseHyphenation1enumOptions: Always (0), Auto (1) (using hyphenation definitions set by WORD in the RTF document) None (2)
UseMarkupfalsebool
UseMarkupAskedfalsebool
UseSignaturefalsebool
UseTifffalseboolUse TIFF
UsedTimeStampServer
string
WatermarkAsBackgroundfalsebool
WatermarkEnabledfalsebool
WatermarkFilename
string
XRechnungPaymentTypeCodeTypeCode30
stringOptions: TypeCode10 (cash payment), TypeCode20 (cheque), TypeCode30 (bank transfer), TypeCode31 (debit transfer non-SEPA), TypeCode42 (payment to bank account), TypeCode48 (electronic purse), TypeCode49 (direct debit), TypeCode57 (standing order), TypeCode58 (SEPA credit transfer), TypeCode59 (SEPA direct debit), TypeCode97 (report / balance between partners)
XRechnungVersion0
enumOptions: XRechnung 1.2.2 (0), 2.0 (1)
ZUGFeRDCreationMethod1enumOptions: xml (0), markup (1)
ZUGFeRDDeleteAfterEmbeddingfalsebool
ZUGFeRDShowAfterCreationtruebool
ZUGFeRDXml
string
Zugferd1ConformanceLevel0enumOptions: basic (0), comfort (1)
Zugferd2ConformanceLevel0enumOptions: basic (0), comfort (1)
Zugferd2PaymentTypeCodeTypeCode30stringOptions: TypeCode10 (cash payment), TypeCode20 (cheque), TypeCode30 (bank transfer), TypeCode31 (debit transfer non-SEPA), TypeCode42 (payment to bank account), TypeCode48 (electronic purse), TypeCode49 (direct debit), TypeCode57 (standing order), TypeCode58 (SEPA credit transfer), TypeCode59 (SEPA direct debit), TypeCode97 (report / balance between partners)

Library

CIB pdf brewer API library can be found in the system's printer driver folder.

Path: C:\Windows\System32\spool\drivers\x64\3.

Library name is CIBpdfBrAPI64_3.dll or CIBpdfBrAPI_3.dll for 32 bit applications.

CibPdfBrJobCreate

Creates a new CIB pdf brewer job.

Syntax

C
int CibPdfBrJobCreate(
  CibPDfBrJobHandle *a_pJob,
int unused
);

Parameters

CibPdfBrJobHandle* a_pJob: Handle of the job.

int unused: Deprecated parameter, set to 0.

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.​

CibPdfBrJobFree

Free CIB pdf brewer job.

Syntax

C
int CibPdfBrJobFree(
  CibPDfBrJobHandle *a_pJob
);

Parameter

CibPdfBrJobHandle* a_pJob: Handle of the job.

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.

CibPdfBrJobGetProperty

Returns the value of a property for a given CIB pdf brewer job. ANSI version is CibPdfBrJobGetPropertyA, Unicode wide version CibPdfBrJobGetPropertyW.

Syntax

C
int CibPdfBrJobGetPropertyA(
  CibPdfBrJobHandle a_hJob,
const char *a_pName,
char *a_pValue,
size_t *a_Length
);

Parameters

CibPdfBrJobHandle a_hJob: >Handle of the job.

const char* a_pName: Name of the property.

char* a_pValue: Storage pointer for the property value, buffer.

size_t* a_Length: Length of the written value.>

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.

Note
If the given buffer size cannot hold the property value, error CIBPRT_ERROR_BUFFERTOOSMALL (47) will be returned.

CibPdfBrJobSetProperty

Sets the value of a property for a given CIB pdf brewer job. ANSI version is CibPdfBrJobSetPropertyA, Unicode wide version CibPdfBrJobSetPropertyW.

Syntax

C
int CibPdfBrJobSetPropertyA(
  CibPdfBrJobHandle a_hJob,
const char *a_pName,
const char *a_pValue
);

Parameters

CibPdfBrJobHandle a_hJob: Handle of the job.>

const char* a_pName: Name of the property.

const char* a_pValue: Value to set for the property a_pName.

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.

CibPdfBrJobStart

Saves the settings made so far by CIB pdf brewer.

Syntax

C
int CibPdfBrJobStart(
  CibPDfBrJobHandle *a_pJob
);

Parameters

CibPdfBrJobHandle* a_pJob: Handle of the job.

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.

CibPdfBrJobWaitFor

Waits for the print job to finish. You should make sure that the print job is being executed and not left in the printer queue.

Syntax

C
int CibPdfBrJobWaitFor(
  CibPDfBrJobHandle *a_pJob,
unsigned long a_TimeOut
);

Parameters

CibPdfBrJobHandle* a_pJob: Handle of the job.

unsigned long a_TimeOut: Timeout in miliseconds.  Use -1 for infinite timeout.

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.

CibPdfBrJobPrint

Start the PDF creation process.

Syntax

C
int CibPdfBrJobPrint(
  CibPDfBrJobHandle *a_pJob
);

Parameters

CibPdfBrJobHandle* a_pJob: Handle of the job.

Return value

If 0 is returned, the function succeeded, function failed otherwise. Check error code list.

CibPdfBrJobGetError

Get last error code for a given job.

Syntax

C
int CibPdfBrJobGetError(
  CibPdfBrJobHandle a_hJob,
int *a_pErrorCode
);

Parameters

CibPdfBrJobHandle a_hJob: Handle of the job.

int *a_pErrorCode: Pointer to an integer to retrieve the error code.

Return value

A positive value (TRUE) is returned if the function succeeded, else a FALSE (0) value is returned.

CibPdfBrJobGetErrorText

Returns if a given file has the possibility to be printed by CIB pdf brewer. ANSI version is CibPdfBrJobGetErrorTextA, Unicode wide version CibPdfBrJobGetErrorTextW.

Syntax

C
int CibPdfBrJobGetErrorTextA(
  CibPdfBrJobHandle a_hJob,
char *a_pText,
long a_MaxLength
);

Parameters

CibPdfBrJobHandle a_hJob: Handle of the job.

char *a_pText: Buffer to store error text.

long a_MaxLength: Maximum buffer size.

Return value

A positive value is returned if true.

CibPdfBrIsPrintAvailable

Returns if a given file has the possibility to be printed by CIB pdf brewer. ANSI version is CibPdfBrIsPrintAvailableA, Unicode wide version CibPdfBrIsPrintAvailableW.

Syntax

C
int CibPdfBrIsPrintAvailableA(
  char *a_pFilename
);

Parameters

char* a_pFilename: Name of the file to check if it can be printed.

Return value

A positive value is returned if true.

CibPdfBrAPIGetVersion

Get CIB pdf brewer API version.

Syntax

C
int CibPdfBrAPIGetVersion(
unsigned long *a_pVersion
);

Parameters

unsigned long *a_pVersion: Pointer to an integer to retrieve CIB pdf brewer version.

Return value

A positive value (TRUE) is returned if the function succeeded, else a FALSE (0) value is returned.

CibPdfBrAPIGetVersionText

Get CIB pdf brewer API version. ANSI version is CibPdfBrAPIGetVersionTextA, and unicode wide version is CibPdfBrAPIGetVersionTextW.

Syntax

C
int CibPdfBrAPIGetVersionTextA(
char *a_pText,
long a_MaxLength
);

Parameters

char *a_pText: Pointer to a char buffer to retrieve CIB pdf brewer version.

long a_MaxLength: Size of buffer.

Return value

A positive value (TRUE) is returned if the function succeeded, else a FALSE (0) value is returned.