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
  NULL
   
    (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:  The converter's handle, which created by function---oakBegin.
    (3) Return value
  NULL
 
 
 
 3. function---oakExport()
     This function start converting.
    (1) Syntax
  long oakExport(long nHandle);
    (2) Parameters
。 nHandle:  The converter's handle, 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:  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.
    (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* pValue3,
                                        char* pValue4);
 
 
 
 Properties
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.
 
 
 
 
 
 
 
 
 
Constants
 
 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_PDFInfo 2105 string Set PDF document information.


Notice: For more detial properties, please click here.

 

 

 2. Return code's definitions
 
 
Name Value Description
RTN_OK 1 Successful operation.
RTN_ERROR1 0 convert fail.
RTN_ERROR2 -1 have not set the output file name.
RTN_ERROR3 -2 have not indicate the input file name.
RTN_ERROR4 -3 invalid instance object number.
     
 
 
 
 
 3. PDF document information keywords's definitions
 
 
Info keywords Value Description
Title "title" title information.
Subject "subject" subject information.
Author "author" author information.
Keywords "keywords" keywords information.
Creator "creator" creator information.
 
 
 
 

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