PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
PDF::InitScope Struct Reference

Represents a scope for initializing and cleaning up the PDF SDK. More...

#include <pdfsdk/cxx/core.h>

Public Member Functions

 InitScope (const std::string &licenseKey, const std::filesystem::path &resourcesDir=std::filesystem::path(), const std::filesystem::path &tempDir=std::filesystem::path(), const std::filesystem::path &appDataDir=std::filesystem::path())
 Constructs an InitScope object and initializes the PDF SDK.
 
 ~InitScope ()
 Destructs the InitScope object and cleans up the PDF SDK.
 
 InitScope (const InitScope &)=delete
 
InitScopeoperator= (const InitScope &)=delete
 
 InitScope (InitScope &&)=delete
 
InitScopeoperator= (InitScope &&)=delete
 

Detailed Description

Represents a scope for initializing and cleaning up the PDF SDK.

This struct provides a convenient way to ensure that the PDF SDK is properly initialized and cleaned up when it is no longer needed. It automatically calls the Init function when the scope is entered and the Done function when the scope is exited.

Constructor & Destructor Documentation

◆ InitScope()

PDF::InitScope::InitScope ( const std::string & licenseKey,
const std::filesystem::path & resourcesDir = std::filesystem::path(),
const std::filesystem::path & tempDir = std::filesystem::path(),
const std::filesystem::path & appDataDir = std::filesystem::path() )
inline

Constructs an InitScope object and initializes the PDF SDK.

Parameters
[in]licenseKeyThe license key for the PDF SDK.
[in]resourcesDirA reference to the resources directory path. This directory holds resources needed by the SDK such as Character Maps, the ICC profile, various font encodings, icons and templates. Defaults to '{currentExeDir}/resources'.
[in]tempDirA reference to the temporary directory path. This directory stores files generated and needed by the SDK during operation. Defaults to the system temporary directory.
[in]appDataDirA reference to the application data directory path. Contains configuration files for the application. Defaults to the system local app data directory.

◆ ~InitScope()

PDF::InitScope::~InitScope ( )
inline

Destructs the InitScope object and cleans up the PDF SDK.

This function is automatically called when the InitScope object goes out of scope. It cleans up and releases any resources used by the PDF SDK.


The documentation for this struct was generated from the following file: