Go (C Interface Binding) new project with Apryse SDK PDF library integration

C interface binding example

This guide is a demo for using our C interface binding and is not a production version of the Go wrapper. Please visit our Apryse SDK for Go documentation for more information on using our production version of Go.

This guide will help you integrate a free trial of the Apryse SDK with Go using Apryse Headers on macOS, Linux or Windows in a new Go app. (Or see instructions for incorporation with an existing project.) Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

• Go 1.6+

macOS

Make sure Go is installed at /usr/local/go and /usr/local/go/bin.

• Apryse SDK for macOS

curl -L -O https://downloads.apryse.com/downloads/PDFNetCMac.zip
unzip PDFNetCMac.zip

• Get your Apryse trial key.

License Key Required

The trial of Apryse SDK requires a trial license key, which is provided in the box titled "License Key". A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Setup

1. Create a project directory called myApp.
2. Extract the PDFNetCMac package as a folder into your project directory.

~/myApp
~/myApp/PDFNetCMac
~/myApp/PDFNetCMac/Headers
~/myApp/PDFNetCMac/Lib
...

Integrate Apryse SDK with Go

1. In your project directory, create a new file called myApp.goAdd the following code inside:Save and close the file.Your folder should look similar to:

package main
// #cgo CFLAGS: -IPDFNetCMac/Headers
// #cgo LDFLAGS: -LPDFNetCMac/Lib -Wl,-rpath,PDFNetCMac/Lib -lPDFNetC
// #include "C/PDF/TRN_PDFNet.h"
// #include "C/SDF/TRN_SDFDoc.h"
// #include "C/PDF/TRN_PDFDoc.h"
// #include "C/PDF/TRN_Page.h"
// #include "C/Common/TRN_UString.h"
// #include "C/Common/TRN_Types.h"
// #include <stdlib.h>
// #include <stdio.h>
import "C"
import (
    "fmt";
    "unsafe"
)
func main() {
    // PDFNet must be initialized before calling other Apryse API
    ccp := C.CString("YOUR_DEMO_KEY")
    C.TRN_PDFNetInitialize(ccp)

    // Create a new PDFDoc
    var doc *C.TRN_PDFDoc
    doc = (*C.TRN_PDFDoc)(C.malloc(C.size_t(unsafe.Sizeof(*doc))))
    C.TRN_PDFDocCreate(doc)

    // Allocate memory for a blank page
    var page *C.TRN_Page
    page = (*C.TRN_Page)(C.malloc(C.size_t(unsafe.Sizeof(*page))))

    // Allocate memory for a default rectangle
    var box *C.TRN_Rect
    box = (*C.TRN_Rect)(C.malloc(C.size_t(unsafe.Sizeof(*box))))

    // Create the page and add it to the document
    C.TRN_PDFDocPageCreate(*doc, box, page)
    C.TRN_PDFDocPagePushBack(*doc, *page)

    // Save the document as a linearized PDF
    var filepath C.TRN_UString
    C.TRN_UStringCreateFromCharString(C.CString("output.pdf"), C.int(10),
    C.e_UString_utf8, &filepath)
    C.TRN_PDFDocSave(*doc, filepath, 0);
    fmt.Println("Hello World!");
}

~/myApp
~/myApp/PDFNetCMac
~/myApp/PDFNetCMac/Headers
~/myApp/PDFNetCMac/Lib
...
~/myApp/myApp.go

1. In the project folder, run:This will produce a myApp executable file.

go build

1. Run the executable file. The executable will produce a pdf with a blank page in a linearized format.

Windows

Make sure Go is part of your path variable.

• Apryse SDK for Windows

• Get your Apryse trial key.

License Key Required

The trial of Apryse SDK requires a trial license key, which is provided in the box titled "License Key". A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Setup

1. Create a project directory inside your go/src/ folder. Call it myAppBy default it should be at this location:

C:/Users/User_Name/go/src/

1. Extract the folder from the .zip file into your project directoryCopy src/myApp/PDFNetC(64)/Lib/PDFNet.dll into src/myApp/

Integrate Apryse SDK with Go

1. In your project directory, create a new file called myApp.goAdd the following code inside:Save and close the file.Your folder should look similar to:

package main
// #cgo CFLAGS: -IPDFNetC64/Headers
// #cgo LDFLAGS: -LPDFNetC64/Lib -Wl,-rpath,$$ORIGIN/PDFNetC64/Lib -lPDFNetC
// #include "C/PDF/TRN_PDFNet.h"
// #include "C/SDF/TRN_SDFDoc.h"
// #include "C/PDF/TRN_PDFDoc.h"
// #include "C/PDF/TRN_Page.h"
// #include "C/Common/TRN_UString.h"
// #include "C/Common/TRN_Types.h"
// #include <stdlib.h>
// #include <stdio.h>
import "C"
import (
    "fmt";
    "unsafe"
)
func main() {
    // PDFNet must be initialized before calling other Apryse API
    ccp := C.CString("YOUR_DEMO_KEY")
    C.TRN_PDFNetInitialize(ccp)

    // Create a new PDFDoc
    var doc *C.TRN_PDFDoc
    doc = (*C.TRN_PDFDoc)(C.malloc(C.size_t(unsafe.Sizeof(*doc))))
    C.TRN_PDFDocCreate(doc)

    // Allocate memory for a blank page
    var page *C.TRN_Page
    page = (*C.TRN_Page)(C.malloc(C.size_t(unsafe.Sizeof(*page))))

    // Allocate memory for a default rectangle
    var box *C.TRN_Rect
    box = (*C.TRN_Rect)(C.malloc(C.size_t(unsafe.Sizeof(*box))))

    // Create the page and add it to the document
    C.TRN_PDFDocPageCreate(*doc, box, page)
    C.TRN_PDFDocPagePushBack(*doc, *page)

    // Save the document as a linearized PDF
    var filepath C.TRN_UString
    C.TRN_UStringCreateFromCharString(C.CString("output.pdf"), C.int(10),
    C.e_UString_utf8, &filepath)
    C.TRN_PDFDocSave(*doc, filepath, 0);
    fmt.Println("Hello World!");
}

1. In the project folder, run:This will produce a myApp.exe file.

go build

1. Run the executable file. The executable will produce a pdf with a blank page in a linearized format.

Linux

Make sure Go is installed at `/usr/local/go` and `/usr/local/go/bin`.

• Apryse SDK for Linux

• Get your Apryse trial key.

License Key Required

The trial of Apryse SDK requires a trial license key, which is provided in the box titled "License Key". A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Setup

1. Create a project directory called myApp.
2. Extract the PDFNetC64 package as a folder into your project directory.

Your files and folders should look similar to:

~/myApp ~/myApp/PDFNetC64 ~/myApp/PDFNetC64/Headers ~/myApp/PDFNetC64/Lib ...

Integrate Apryse SDK with Go

1. In your project directory, create a new file called myApp.goAdd the following code inside:Save and close the file.Your files and folders should look similar to:

package main
// #cgo CFLAGS: -IPDFNetC64/Headers
// #cgo LDFLAGS: -LPDFNetC64/Lib -Wl,-rpath,PDFNetC64/Lib -lPDFNetC
// #include "C/PDF/TRN_PDFNet.h"
// #include "C/SDF/TRN_SDFDoc.h"
// #include "C/PDF/TRN_PDFDoc.h"
// #include "C/PDF/TRN_Page.h"
// #include "C/Common/TRN_UString.h"
// #include "C/Common/TRN_Types.h"
// #include <stdlib.h>
// #include <stdio.h>
import "C"
import (
    "fmt";
    "unsafe"
)
func main() {
    // PDFNet must be initialized before calling other Apryse API
    ccp := C.CString("YOUR_DEMO_KEY")
    C.TRN_PDFNetInitialize(ccp)

    // Create a new PDFDoc
    var doc *C.TRN_PDFDoc
    doc = (*C.TRN_PDFDoc)(C.malloc(C.size_t(unsafe.Sizeof(*doc))))
    C.TRN_PDFDocCreate(doc)

    // Allocate memory for a blank page
    var page *C.TRN_Page
    page = (*C.TRN_Page)(C.malloc(C.size_t(unsafe.Sizeof(*page))))

    // Allocate memory for a default rectangle
    var box *C.TRN_Rect
    box = (*C.TRN_Rect)(C.malloc(C.size_t(unsafe.Sizeof(*box))))

    // Create the page and add it to the document
    C.TRN_PDFDocPageCreate(*doc, box, page)
    C.TRN_PDFDocPagePushBack(*doc, *page)

    // Save the document as a linearized PDF
    var filepath C.TRN_UString
    C.TRN_UStringCreateFromCharString(C.CString("output.pdf"), C.int(10),
    C.e_UString_utf8, &filepath)
    C.TRN_PDFDocSave(*doc, filepath, 0);
    fmt.Println("Hello World!");
}

~/myApp
~/myApp/PDFNetCMac
~/myApp/PDFNetCMac/Headers
~/myApp/PDFNetCMac/Lib
...
~/myApp/myApp.go

1. In the project folder, run:This will produce a myApp executable file.

go build

1. Run the executable file. The executable will produce a pdf with a blank page in a linearized format.

Want to generate your own bindings?

You can generate bindings for Apryse SDK APIs using various methods. It is recommended to use SWIG to generate these bindings. The header files to include can be found in PDFNET_BASE\Headers\ and the library can be found in PDFNET_BASE\Lib\.

Next step

GuidesAPI docsSamples