Path Names

Access to data path names for Installation. More...

Macros
#define	openiccSCOPE_OPENICC   0x04
#define	openiccSCOPE_MACHINE   0x08

Enumerations
enum	openiccPATH_TYPE_e { ,   openiccPATH_ICC = 0x01, openiccPATH_POLICY = 0x02, openiccPATH_MODULE = 0x04, openiccPATH_SCRIPT = 0x08,   openiccPATH_CACHE = 0xf0, openiccPATH_LOGO = 0xf1 }
	data type selectors More...
enum	openiccSCOPE_e { openiccSCOPE_USER_SYS = 0x0, openiccSCOPE_USER = 0x01, openiccSCOPE_SYSTEM = 0x02 }
	Select Scope for Installation or Configurations. More...

Functions
char *	openiccGetInstallPath (openiccPATH_TYPE_e type, openiccSCOPE_e scope, openiccAlloc_f allocFunc)
	get Path Name for Installation More...
char *	openiccDBGetJSONFile (openiccSCOPE_e scope)
	obtain path string of OpenICC DB More...

Detailed Description

Access to data path names for Installation.

The obtained informations can be used outside OpenICC, to do system specific operations, which do not easily fit into the library.

Macro Definition Documentation

openiccSCOPE_MACHINE

#define openiccSCOPE_MACHINE   0x08

use machine data scope

Examples:

test.c.

openiccSCOPE_OPENICC

#define openiccSCOPE_OPENICC   0x04

use OpenICC installation data scope

Examples:

test.c.

Enumeration Type Documentation

openiccPATH_TYPE_e

enum openiccPATH_TYPE_e

data type selectors

Enumerator
openiccPATH_ICC	ICC profile path
openiccPATH_POLICY	policy data
openiccPATH_MODULE	module data
openiccPATH_SCRIPT	JIT code
openiccPATH_CACHE	cached files
openiccPATH_LOGO	logo images

openiccSCOPE_e

enum openiccSCOPE_e

Select Scope for Installation or Configurations.

Enumerator
openiccSCOPE_USER_SYS	do not limit search to one scope
openiccSCOPE_USER	use user data scope
openiccSCOPE_SYSTEM	use system data scope

Examples:

test.c.

Function Documentation

openiccDBGetJSONFile()

char* openiccDBGetJSONFile

(

openiccSCOPE_e

scope

)

obtain path string of OpenICC DB

Parameters

[in]

scope

specify to intended user or system scope

Returns

file path string

openiccGetInstallPath()

char * openiccGetInstallPath	(	openiccPATH_TYPE_e	type,
		openiccSCOPE_e	scope,
		openiccAlloc_f	allocFunc
	)

get Path Name for Installation

Note: Not all combinations return a path name. Some make no sense. So be careful and test the result.

openiccPATH_MODULE + openiccSCOPE_USER and openiccPATH_MODULE + openiccSCOPE_OPENICC are supported.

Version

OpenICC: 0.1.1

Date

2018/06/09

Since

2015/02/08 (OpenICC: 0.1.0)

Examples:

test.c.