IPSDKCore/html/a14924_source.html

 // SystemApi.h:
 // ------------
 //

 #ifndef __IPSDKUTIL_SYSTEMAPI_H__
 #define __IPSDKUTIL_SYSTEMAPI_H__

 #include <IPSDKUtil/IPSDKUtilExports.h>
 #include <IPSDKUtil/BaseTypes.h>
 #include <IPSDKUtil/Tools/ProcessingResultTypes.h>

 namespace ipsdk {


 IPSDKUTIL_API std::string
 getHostName();

 IPSDKUTIL_API std::string
 getPlatformBinaryName(const std::string& baseName);

 IPSDKUTIL_API std::string
 getPlatformLibraryName(const std::string& baseName);

 IPSDKUTIL_API std::string
 getPlatformExecName(const std::string& baseName);

 IPSDKUTIL_API std::string
 getPlatformBinaryDirPostFix();

 IPSDKUTIL_API BoolResult
 loadLibrary(const boost::filesystem::path& filePath);

 IPSDKUTIL_API BoolResult
 addLibraryDirectory(const boost::filesystem::path& dirPath);

 IPSDKUTIL_API std::string
 getPlatformName();

 IPSDKUTIL_API bool
 is64BitsConfig();

 IPSDKUTIL_API bool
 isDebugConfig();

 IPSDKUTIL_API std::string
 getFullPlatformName();

 IPSDKUTIL_API std::string
 getOSName();

 IPSDKUTIL_API BoolResult
 displayHtml(const boost::filesystem::path& filePath);

 IPSDKUTIL_API BoolResult
 getApplicationPath(boost::filesystem::path& appPath);

 IPSDKUTIL_API BoolResult
 getApplicationDir(boost::filesystem::path& appDir);

 IPSDKUTIL_API BoolResult
 getApplicationName(std::string& appName);

 IPSDKUTIL_API BoolResult
 getUserRootDataDir(boost::filesystem::path& dataPath);

 IPSDKUTIL_API BoolResult
 getCommonRootDataDir(boost::filesystem::path& dataPath);

 IPSDKUTIL_API BoolResult
 getUserLibraryDataDir(boost::filesystem::path& dataPath);

 IPSDKUTIL_API BoolResult
 getCommonLibraryDataDir(boost::filesystem::path& dataPath);

 IPSDKUTIL_API std::string
 #ifdef IPSDK_WINDOWS
 getLastError(ipUInt32 errorCode);
 #else
 getLastError(ipInt32 errorCode);
 #endif

 IPSDKUTIL_API std::string
 getLastError();

 IPSDKUTIL_API void
 setThreadName(const std::string& threadName);

 IPSDKUTIL_API BoolResult
 createProcess(const boost::filesystem::path& execPath,
               const std::string& cmdArgs,
               const ipUInt32 timeout,
               ipInt32& exitCode);

 IPSDKUTIL_API BoolResult
 createProcess(const boost::filesystem::path& execPath,
               const std::string& cmdArgs,
               std::string& stdOutStr);


 } // end of namespace ipsdk

 #endif // __IPSDKUTIL_SYSTEMAPI_H__
ipsdk
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22

ipsdk::getPlatformLibraryName
IPSDKUTIL_API std::string getPlatformLibraryName(const std::string &baseName)
retrieve full ipsdk (platform dependent) library name from its base name

ipsdk::getPlatformBinaryDirPostFix
IPSDKUTIL_API std::string getPlatformBinaryDirPostFix()
retrieve platform dependent binary directory post fix. Example : msvc11_x64, linux_x64, ...

ipsdk::isDebugConfig
IPSDKUTIL_API bool isDebugConfig()
retrieve debug flag

ipsdk::getUserRootDataDir
IPSDKUTIL_API BoolResult getUserRootDataDir(boost::filesystem::path &dataPath)
retrieve root user data directory

ipsdk::ipInt32
int32_t ipInt32
Base types definition.
Definition: BaseTypes.h:52

ipsdk::getPlatformExecName
IPSDKUTIL_API std::string getPlatformExecName(const std::string &baseName)
retrieve full ipsdk (platform dependent) executable name from its base name

ipsdk::getLastError
IPSDKUTIL_API std::string getLastError(ipInt32 errorCode)
function allowing to retrieve error string from value

ipsdk::getApplicationDir
IPSDKUTIL_API BoolResult getApplicationDir(boost::filesystem::path &appDir)
retrieve application directory

ipsdk::getHostName
IPSDKUTIL_API std::string getHostName()
retrieve local host name

ipsdk::loadLibrary
IPSDKUTIL_API BoolResult loadLibrary(const boost::filesystem::path &filePath)
load library given its path

ipsdk::getPlatformBinaryName
IPSDKUTIL_API std::string getPlatformBinaryName(const std::string &baseName)
retrieve full ipsdk (platform dependent) binary name from its base name

BaseTypes.h
Base types for multiplatform compatibility.

ipsdk::getOSName
IPSDKUTIL_API std::string getOSName()
retrieve full operating system name

ipsdk::getApplicationName
IPSDKUTIL_API BoolResult getApplicationName(std::string &appName)
retrieve application name

ipsdk::displayHtml
IPSDKUTIL_API BoolResult displayHtml(const boost::filesystem::path &filePath)
display html file through default browser

ipsdk::addLibraryDirectory
IPSDKUTIL_API BoolResult addLibraryDirectory(const boost::filesystem::path &dirPath)
add a library directory for library delay load search

IPSDKUTIL_API
#define IPSDKUTIL_API
Import/Export macro for library IPSDKUtil.
Definition: IPSDKUtilExports.h:27

ipsdk::getCommonRootDataDir
IPSDKUTIL_API BoolResult getCommonRootDataDir(boost::filesystem::path &dataPath)
retrieve root common (all users) data directory

IPSDKUtilExports.h
Definition of import/export macro for library.

ipsdk::createProcess
IPSDKUTIL_API BoolResult createProcess(const boost::filesystem::path &execPath, const std::string &cmdArgs, const ipUInt32 timeout, ipInt32 &exitCode)

ipsdk::getUserLibraryDataDir
IPSDKUTIL_API BoolResult getUserLibraryDataDir(boost::filesystem::path &dataPath)
retrieve library user data directory

ipsdk::BoolResult
ProcessingResult< bool > BoolResult
typedef for boolean results associated to a string description
Definition: ProcessingResultTypes.h:29

ProcessingResultTypes.h
Predefined types for processing results management.

ipsdk::is64BitsConfig
IPSDKUTIL_API bool is64BitsConfig()
retrieve x64 flag

ipsdk::getApplicationPath
IPSDKUTIL_API BoolResult getApplicationPath(boost::filesystem::path &appPath)
retrieve application path

ipsdk::getFullPlatformName
IPSDKUTIL_API std::string getFullPlatformName()
retrieve full platform name

ipsdk::setThreadName
IPSDKUTIL_API void setThreadName(const std::string &threadName)
function allowing to set current thread name for debugging purpose

ipsdk::getPlatformName
IPSDKUTIL_API std::string getPlatformName()
retrieve platform name

ipsdk::getCommonLibraryDataDir
IPSDKUTIL_API BoolResult getCommonLibraryDataDir(boost::filesystem::path &dataPath)
retrieve library common data directory

ipsdk::ipUInt32
uint32_t ipUInt32
Base types definition.
Definition: BaseTypes.h:53