This section describes the sdk interfaces detailedly. |
Function |
1. function---oakBegin() |
|
This function create a instance and return the converter's handle. |
|
If the function succeeds, it returns a converter's handle. If the function fail, it returns a error code, for more error codes, please click here. |
|
This function close the instance and destroy the converter appointed by the handle. |
|
void oakEnd(long nHandle); |
。 |
nHandle: The converter's handle, which created by function---oakBegin. |
3. function---oakExport() |
|
This function start converting. |
|
long oakExport(long nHandle); |
|
|
。 |
nHandle: The converter's handle, which created by function---oakBegin. |
|
|
|
It returns RTN_OK, the function succeeds, otherwise the function fails. For more error codes, please click here. |
4. function---oakSetOption() |
|
This function is to set the converter's properties, which created by function---oakBegin. |
|
long oakSetOption( long nHandle,
long nIndex,
long nValue1,
long nValue2,
char* pValue1,
char* pValue2); |
。 |
nHandle: The converter's handle, which created by function---oakBegin. |
。 |
nIndex: Property tag, refer to the section of definitions of oakSetOption properties. |
。 |
nValue1: An integer value of the property. |
。 |
nValue2: An integer value of the property. |
。 |
pValue1: A String value of the property. |
。 |
pValue:2 A String value of the property. |
|
It returns RTN_OK, the function succeeds, otherwise the function fails. For more error codes, please click here. |
5. function---oakGetOption() -- none properties for the moment |
|
This function is to get the converter's properties, which created by function---oakBegin. |
|
long oakGetOption( long nHandle,
long nIndex,
long nValue1,
long nValue2,
char* pValue3,
char* pValue4); |
|
This section describes the properties of the function oakSetOption detailedly. |
1. Property OAK_Set_Output |
|
This property can be using to set the output file .
The paramater pValue3 is the output file.
Note:if setting more than once, comfirmed to the last set. |
2. Property OAK_Set_Input |
|
This property can be using to set the input file .
The paramater pValue3 is the input file.
|
3. Property OAK_Set_PDFInfo |
|
This property sets the PDF document information.
The paramater pValue3 is the information keywords.
The paramater pValue4 is the content of the document information. |
4. Property OAK_Set_PDFEncrypt |
|
This property sets the PDF password protection.
The paramater nValue1 is to set pdf encrypt level.
Two kinds of encrypt level are supported, 40bits and 128bits, default is 40bits.
OAK_PDF_ENCRYPT_LEVEL_40: 40
OAK_PDF_ENCRYPT_LEVEL_128: 128
The paramater nValue2 is to set pdf operation permission.
The pdf operation permissions are listed at the following.
OAK_PDF_PERMISSION_NONE: 0
OAK_PDF_PERMISSION_PRINT: 1
OAK_PDF_PERMISSION_COPYING: 2
OAK_PDF_PERMISSION_MODIFY: 4
Notes: You can combinate the three operaion permissions of printing, copying and modify at will.
eg: OAK_PDF_PERMISSION_ALL=OAK_PDF_PERMISSION_PRINT+OAK_PDF_PERMISSION_COPYING+OAK_PDF_PERMISSION_MODIFY=7
|
|
|
This property sets images and graphics elements of pdf.
The paramater nValue1 is to set horizontal resolution.
The paramater nValue2 is to set vertical resolution.
Notes: The component supports the resolution from 72dpi to 600dpi, defualt is 150dpi. |
1. Definitions of oakSetOption's properties |
|
(1) properties
Name |
Value |
Type |
Description |
OAK_Set_Output |
2101 |
string |
Destination file. |
OAK_Set_Input |
2102 |
string |
Input file. |
OAK_Set_DPI |
2103 |
long |
PDF resolution. |
OAK_Set_PDFInfo |
2105 |
string |
Set PDF document information. |
OAK_Set_PDFEncrypt |
2106 |
long |
Set PDF password protection. |
Notice: For more detial properties, please click here. |
2. Definitions of return code |
|
Name |
Value |
Description |
RTN_OK |
1 |
Successful operation. |
RTN_ERROR1 |
0 |
Failure convertion. |
RTN_ERROR2 |
-1 |
None of setting output file name. |
RTN_ERROR3 |
-2 |
None of setting input file name. |
RTN_ERROR4 |
-3 |
Invalid instance object number. |
|
|
|