API

Full list of API settings

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

Syntax

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

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

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

CibPdfBrJobSetProperty

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

Syntax

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

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

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

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

Syntax

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

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

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

Syntax

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

Syntax

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.