Get Started with the Apryse Server SDK C++ PDF Library Integration

This section helps you get started with one of our samples to see the output you can create when you integrate the Apryse Server SDK into your application. It also includes instructions on how to create a C++ project, then integrate Server SDK into the project. In the end, you’ll create and open a blank PDF within your project.

Before you start:

• Install Visual Studio Code to write, build, test, and deploy your application.
• Install GCC (GNU Compiler Collection) to build and compile C++ into executable programs.
• Download Apryse’s C++ PDF Library for Linux file: Apryse Server SDK 64-bit or 64-bit ARM.
• Get your Apryse trial key.

In this section, you will download and run the OfficeToPDFTest PDFNet sample module, which demonstrates the SDK's document-conversion capabilities. Upon successful completion, you will have converted a DOCX document to a PDF file while leveraging the MS Office-to-PDF conversion API. You can use this module as a reference implementation when integrating similar document-conversion functionality into your own applications. By running the sample, you can quickly:

• Verify the capabilities.
• Understand how to interact with the MS Office to Conversion PDF API.
• Use it as a reference for integrating similar functionality into your own application.

1. Download the tarball file for Linux suitable for your processor.  For this guide we’ll use the PDFNetC64.tar.gz file.
2. Navigate to the Downloads folder, right-click on the PDFNetC64.tar.gz file, then select Extract to...
3. Select Home, New Folder, and then enter ApryseSamples.
4. Click Create to create the new folder and then click Select to extract the tarball file into your new folder.

The ApryseSamples folder is created and the tarball is extracted to the folder.

5. Navigate to: /Home/ApryseSamples/PDFNetC64/Samples/LicenseKey/CPP/LicenseKey.h and double-click to open so you can add your license key to the LicenseKey.h file before running the sample. (Note that the folder may be named CPP or CPPS, depending on your distribution.)

6. Scroll down to the line containing //#define LicenseKey “YOUR_PDF_LICENSE_KEY”. Uncomment this line (remove the // ) and replace the words in quotes with the copy of your trial license key you generated when you completed the Prerequisites instructions above. Do not change any other information in this file.

7. Save your changes and close the LicenseKey.h file.

8. To run the sample, navigate to: /Home/ApryseSamples/PDFNetC64/Samples/OfficeToPDFTest/CPP, right-click on the CPP folder, then select Open in Terminal (CPP or CPPS folder, depending on your distribution).

9. The Linux terminal opens the OfficeToPDFTest sample. From the project directory, in the terminal, enter the following, then press Enter:

1Make

Then enter the following and press Enter:

1./OfficeToPDFTest

10. When you run the ./OfficeToPDFTest command, the sample code loads an Office document, converts the Office document to PDF, saves the resulting PDF, and outputs status messages to the console. For more details, you can look at additional OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

Once the sample has finished running, you’ll see the status Done in the terminal.

11. In the terminal, type exit, then press Enter.

12. Navigate to: /Home/ApryseSamples/PDFNetC64/Samples/TestFiles/Output. You will see three output PDF files (Fishermen.pdf, the_rime_of_the_ancient_mariner.pdf, and the factsheet_Arabic.pdf).

13. Open the PDF files to see the converted output. You have successfully run the OfficeToPDFTest conversion sample.

14. Close the output PDF files.

This section provides steps to create a simple C++ project that you can, later, integrate with the Server SDK.

1. Open Visual Studio Code and select File > Open Folder.
2. Navigate to: /Home/ApryseSamples/PDFNetC64/Samples.
3. Click Create Folder, enter myApp, then click Create.
4. Open the myApp folder and create a CPP folder (or CPPS depending on your distribution). To exit out of the Open Folder dialog box select Cancel.
5. Go to the Main menu in Visual Studio Code and select File > New File...
6. In the New File... dialog box, enter myAPP.cpp and press Enter.
7. Navigate to: /ApryseSamples/PDFNetC64/Samples/myApp/CPP and click Create File. The myApp.cpp file is created.

This section integrates the Apryse Server SDK and the PDFNet library to programmatically generate a blank PDF document. With these steps, you can learn how to set up your environment and import the required libraries.

1. In Visual Studio Code, copy the following code and paste it into the myApp.cpp file:

1#include <iostream>
2#include <PDF/PDFNet.h>
3#include <PDF/PDFDoc.h>
4#include <SDF/ObjSet.h>
5
6using namespace pdftron;
7using namespace PDF;
8using namespace SDF;
9
10int main(int argc, char** argv)
11{
12 try
13    {
14    PDFNet::Initialize("YOUR_PDFTRON_LICENSE_KEY");  // PDFNet must be initialized before accessing any Apryse API. This line should only be called once in your main function.
15    PDFDoc doc;
16    Page page = doc.PageCreate(); // Start a new page
17    doc.PagePushBack(page);       // Add the page to the document
18    doc.Save("output.pdf", SDFDoc::e_linearized);  // Save the document as a linearized PDF
19    std::cout << "Hello World!" << std::endl;
20    }
21   catch(pdftron::Common::Exception& ex)
22    {
23        std::cout << ex << std::endl;
24    }
25    return 0;
26}

2. Scroll down to the line containing PDFNet::Initialize(“YOUR_PDFTRON_LICENSE_KEY”); and replace the words in quotes with the copy of your trial license key. Save your changes and close the file.

You’ll run the project to get a blank PDF as your output.

1. Navigate to: /Home/ApryseSamples/PDFNetC64/Samples/myApp/CPP, right-click on the CPP folder and select Open in Terminal.
2. To build the project, enter the following and press Enter:

1g++ myApp.cpp -I../../../Headers -L../../../Lib -lPDFNetC -lstdc++ -lpthread -lm -lc -Wl,-rpath,../../../Lib -Wl,-rpath$ORIGIN -o myApp

To run the application, enter the following and press Enter:

1./myApp

You will see a message in the terminal:

1PDFNet is running in demo mode.
2
3PackageV2: base
4
5Hello World!

The sample code you just ran performs the following actions:

• Includes the required Apryse (PDFNet) header files.
• Initializes the PDFNet SDK using the provided license key.
• Creates a new PDF document in memory.
• Adds a blank page to the document.
• Saves the document as a linearized PDF file.
• Terminates the PDFNet SDK.
• Outputs any runtime errors to the console.

3. Navigate to: /Home/ApryseSamples/PDFNetC64/Samples/myApp/CPP.

4. Open the output.pdf which you created by integrating the Apryse Server SDK.

Now that you have successfully run the OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK C++ PDF Library into your application, you can try out 50+ samples depending on your needs.

5. To try additional samples, go to section 1. Run a PDFNet sample project > step 4 above and choose another sample to run.

This section helps you get started with one of our samples to see the output you can create when you integrate the Apryse Server SDK into your application. It also includes instructions on how to create a C++ project, then integrate Server SDK into the project. In the end, you’ll create and open a blank PDF within your project.

Before you start:

• Install Visual Studio Code to write, build, test, and deploy your application.
• Install GCC (GNU Compiler Collection) to build and compile C++ into executable programs.
• Download Apryse’s C++ PDF Library for macOS file: Apryse Server SDK 64-bit.
• Get your Apryse trial key.

In this section, you will download and run the OfficeToPDFTest PDFNet sample module, which demonstrates the SDK's document-conversion capabilities. Upon successful completion, you will have converted a DOCX document to a PDF file while leveraging the MS Office-to-PDF conversion API. You can use this module as a reference implementation when integrating similar document-conversion functionality into your own applications. By running the sample, you can quickly:

• Verify the capabilities.
• Understand how to interact with the MS Office to Conversion PDF API.
• Use it as a reference for integrating similar functionality into your own application.

1. Download the PDFNetCMac.zip file.
2. Double-click the PDFNetCMac.zip file to unzip it.
3. In your Documents folder, create a new ApryseSamples folder for the sample files.

4. Move the unzipped PDFNetCMac folder to the new ApryseSamples folder.

5. In your terminal, go to the Documents/ApryseSamples directory and remove the quarantine attribute from all files so the sample can run:

1cd Documents/ApryseSamples
2sudo xattr -dr com.apple.quarantine .

6. Open the Documents/ApryseSamples/PDFNetCMac/Samples/LicenseKey/CPP/LicenseKey.h file in Visual Studio Code. (Note that the folder may be named CPP or CPPS, depending on your distribution.)

7. Scroll down to the line containing //#define LicenseKey “YOUR_PDF_LICENSE_KEY”. Uncomment this line (remove the // ) and replace the words in quotes with the copy of your trial license key you generated when you completed the Prerequisites instructions above. Do not change any other information in this file.

8. Save your changes and close the LicenseKey.h file.

9. To run the sample, navigate to: /Documents/ApryseSamples/PDFNetCMac/Samples/OfficeToPDFTest/CPP, right-click on the CPP folder, then select New Terminal at Folder (CPP or CPPS folder, depending on your distribution).

10. The terminal opens the OfficeToPDFTest sample. From the project directory, in the terminal, enter the following, then press Enter:

1Make

Then enter the following and press Enter:

1./OfficeToPDFTest

11. When you run the ./OfficeToPDFTest command, the sample code loads an Office document, converts the Office document to PDF, saves the resulting PDF, and outputs status messages to the console. For more details, you can look at additional OfficeToPDF sample code and the Convert MS Office (Word, Excel, PowerPoint) to PDF overview.

Once the sample has finished running, you’ll see the status Done in the terminal.

12. In the terminal, type exit, then press Enter.

13. Navigate to: /Documents/ApryseSamples/PDFNetCMac/Samples/TestFiles/Output. You will see three output PDF files (Fishermen.pdf, the_rime_of_the_ancient_mariner.pdf, and the factsheet_Arabic.pdf).

14. Open the PDF files to see the converted output. You have successfully run the OfficeToPDFTest conversion sample.

15. Close the output PDF files.

This section provides steps to create a simple C++ project that you can, later, integrate with the Server SDK.

1. Open Visual Studio Code and select File > Open Folder...
2. Navigate to: /Documents/ApryseSamples/PDFNetCMac/Samples.
3. Create a new folder named myApp.
4. Inside myApp, create a folder named CPP (or CPPS depending on your distribution).
5. Open the CPP folder.
6. Create a new file named myApp.cpp.

This section integrates the Apryse Server SDK and the PDFNet library to programmatically generate a blank PDF document. With these steps, you can learn how to set up your environment and import the required libraries.

1. In Visual Studio Code, copy the following code and paste it into the myApp.cpp file:

1#include <iostream>
2#include <PDF/PDFNet.h>
3#include <PDF/PDFDoc.h>
4#include <SDF/ObjSet.h> 
5
6using namespace pdftron;
7using namespace PDF;
8using namespace SDF;
9
10int main(int argc, char** argv)
11{
12 try
13    {
14    PDFNet::Initialize("YOUR_PDFTRON_LICENSE_KEY");  // PDFNet must be initialized before accessing any Apryse API. This line should only be called once in your main function.
15    PDFDoc doc;
16    Page page = doc.PageCreate(); // Start a new page
17    doc.PagePushBack(page);       // Add the page to the document
18    doc.Save("output.pdf", SDFDoc::e_linearized);  // Save the document as a linearized PDF
19    std::cout << "Hello World!" << std::endl;
20    }
21   catch(pdftron::Common::Exception& ex)
22    {
23        std::cout << ex << std::endl;
24    }
25    return 0;
26}

2. Scroll down to the line containing PDFNet::Initialize(“YOUR_PDFTRON_LICENSE_KEY”); and replace the words in quotes with the copy of your trial license key. Save your changes and close the myApp.cpp file.

You’ll run the project to get a blank PDF as your output.

1. Navigate to: /Documents/ApryseSamples/PDFNetCMac/Samples/myApp/CPP, right-click on the CPP folder and select NewTerminal at Folder.
2. To build the project, enter the following and press Enter:

1g++ myApp.cpp -I../../../Headers -L../../../Lib -lPDFNetC -lstdc++ -lpthread -lm -lc -Wl,-rpath,../../../Lib -Wl,-rpath$ORIGIN -o myApp

To run the application, enter the following and press Enter:

1./myApp

You will see a message in the terminal: 

1PDFNet is running in demo mode. 
2
3PackageV2: base  
4
5Hello World!

The sample code you just ran performs the following actions:

• Includes the required Apryse (PDFNet) header files.
• Initializes the PDFNet SDK using the provided license key.
• Creates a new PDF document in memory.
• Adds a blank page to the document.
• Saves the document as a linearized PDF file.
• Terminates the PDFNet SDK.
• Outputs any runtime errors to the console.

3. Navigate to: /Documents/ApryseSamples/PDFNetCMac/Samples/myApp/CPP.

4. Open the output.pdf which you created by integrating the Apryse Server SDK.

Now that you have successfully run the OfficeToPDFTest sample (in section 1) and integrated the Apryse Server SDK C++ PDF Library into your application, you can try out 50+ samples depending on your needs.

5. To try additional samples, go to section 1. Run a PDFNet sample project > step 3 above and choose another sample to run.