CIB pdf toolbox 2 technical documentation

2. API Documentation

2.9. CibPdf2JobGetPropertyUtf8

uint32_t CibPdf2JobGetPropertyUtf8(CibPdfJobHandle job, const char* name, char* value,size_t* maxLength);

By this function you can retrieve properties, after you executed the job. The provided buffer in
value must provide enough bytes to retrieve the data, otherwise an error is returned.
maxLength will always contain after executing the needed length.

Parameter:

Type

Variable 

Meaning

CibPdfJobHandle

Job 

Handle of the job

const char*

name

Name of the job-property (in UTF-8)

char*

value

Value of the job-property (in UTF-8)

size_t*

maxLength

As Input the provided length of the value buffer. After
executing it contains the length of the buffer, which
was really used.

The function returns 0 on success, otherwise an error code.