Programmer's Reference previous  top  next 
This section describes the sdk interfaces detailedly.
 
Function
Properties
Constants


 Function
 1. function---oakBegin()
     This function create a instance and return the converter's handle.
    (1) Syntax
  long oakBegin(void);
    (2) Parameters
    (3) Return value
  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.
   
 
 2. function---oakEnd()
     This function close the instance and destroy the converter appointed by the handle.
    (1) Syntax
  void oakEnd(long nHandle);
    (2) Parameters
。 nHandle:  A handle of the converter, which created by function---oakBegin.
    (3) Return value
 
 
 3. function---oakExport()
     This function start converting.
    (1) Syntax
  long oakExport(long nHandle);
    (2) Parameters
。 nHandle:  A handle of the converter, which created by function---oakBegin.
   
    (3) Return value
  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.
    (1) Syntax
  long oakSetOption( long nHandle,
                               long nIndex,
                               long nValue1,
                               long nValue2,
                               char* pValue1,
                               char* pValue2);
    (2) Parameters
。 nHandle:  A handle of the converter, 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.
    (3) Return value
  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.
    (1) Syntax
  long oakGetOption( long nHandle,
                               long nIndex,
                               long nValue1,
                               long nValue2,
                               char* pValue1,
                               char* pValue2);
    (2) Parameters --- refer to oakSetOption.
    (3) Return value --- refer to oakSetOption.
 
 
 Properties
This section describes the properties of the functions oakSetOption and oakGetOption detailedly.

 
 1. Property OAK_Set_Output
  This property can be using to set destination pdf files(Supports absolute path and relative path).
The paramater pValue1 is the output file.
Note：if the settings more than once, the last setting is comfirmed.
 
 2. Property OAK_Set_Input
  This property can be using to set source ps/eps files(Supports absolute path and relative path).
The paramater pValue1 is the input file.
 
 3. Property OAK_Set_PDFInfo
  This property sets the PDF document information.
The paramater pValue1 is the information keywords.
The paramater pValue2 is the content of the document information.
 
 4. Property OAK_Set_PDFEncrypt
  This property sets encrpt mode of PDF document.
The paramater pValue3 is the information keywords.
The paramater pValue4 is the content of the document information.
   
   
   
Constants
 
 1. Definitions of oakSetOption's properties
 
Name Value Type Description
OAK_Set_Input 5301 string Source ps/eps file(Supports absolute path and relative path).
OAK_Set_Output 5302 string Destination pdf file(Supports absolute path and relative path).
OAK_Set_PDFInfo 5307 string Set PDF document information(refer to information).
OAK_Set_PDFEncrypt 5308 integer PDF encrpt mode(40bits or 128bits).
Notice: For more detial properties, please click here.
   
 2. Return code's definitions
 
 
Name Value Description
RTN_OK  1 Operation success.
RTN_FAILURE  0 Operation failure.
RTN_ERR_NONE_OUTPUT -1 Destination file unspecified.
RTN_ERR_NONE_INPUT -2 Source file unspecified.
RTN_ERR_INVALID_HANDLE -3 Invalid converter handle.
RTN_ERR_MEMORY -4 Memory operation failure.
RTN_ERR_INVALID_FORMAT -5 Invalid format of destination file.
   
 3. Header informations of PDF document
 
 
Info keywords Value Description
OAK_PDF_TITLE "title" title information.
OAK_PDF_SUBJECT "subject" subject information.
OAK_PDF_AUTHOR "author" author information.
OAK_PDF_KEYWORDS "keywords" keywords information.
OAK_PDF_APPLICATION "creator" application/creator information.
 
     
 4. Supported security permission of PDF document
 
 
Info keywords Value Description
OAK_PDF_PERMISSION_NONE 0 All permissions are limited.
OAK_PDF_PERMISSION_PRINT 1 Print permission is accepted.
OAK_PDF_PERMISSION_COPYING 2 Copying permission is accepted.
OAK_PDF_PERMISSION_MODIFY 4 Modify permission is accepted.
OAK_PDF_PERMISSION_ALL 7 All permissions are accepted.
 
     

http://www.oakdoc.com  
Copyright 2008 by OakDoc Technology, Inc. All rights reserved.